InteractiveAutomationToolkit/Components/Generics/EnumDropDown.cs

@@ -0,0 +1,96 @@
+namespace Skyline.DataMiner.Utils.InteractiveAutomationScript
+{
+	using System;
+	using System.Collections.Generic;
+	using System.ComponentModel;
+	using System.Linq;
+
+	/// <summary>
+	///  A dropdown that allows users to select a value defined by an enum.
+	/// </summary>
+	/// <typeparam name="T">Enum type to represent with the dropdown.</typeparam>
+	/// <example>
+	///	<code>
+	///	public enum Capitol
+	/// {
+	///		Brussels,
+	///		[Description("Washington DC")]
+	///		WashingtonDc,
+	///		[Description("Buenos Aires")]
+	///		BuenosAires,
+	///		Lisbon,
+	///		Cairo,
+	///		Paris
+	/// }
+	///
+	/// var capitolDropDown = new EnumDropDown&lt;Capitol&gt;();
+	/// var selectedCapitol = capitolDropDown.Selected;
+	/// capitolDropDown.Changed += (s, e) =>
+	/// {
+	///		engine.Log($"Capitol changed from {e.Previous} to {e.Selected}");
+	///		selectedCapitol = e.Selected;
+	/// };
+	///	</code>
+	/// </example>
+	public class EnumDropDown<T> : DropDown<T> where T : struct, Enum
+	{
+		private readonly Func<T, string> convertValueToString;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="EnumDropDown{T}"/>
+		/// </summary>
+		/// <param name="exclude">Values of the enum to exclude as options from the dropdown.</param>
+		/// <remarks>
+		/// The display value of the enum is determined by the presence of the <see cref="DescriptionAttribute"/>.
+		/// If this attribute isn't defined, the .ToString() representation is used.
+		/// </remarks>
+		public EnumDropDown(ICollection<T> exclude = null) : this(DefaultConversion, exclude) { }
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="EnumDropDown{T}"/>
+		/// </summary>
+		/// <param name="convertValueToString">Function to map the enum value to its string representation.</param>
+		/// <param name="exclude">Values of the enum to exclude as options from the dropdown.</param>
+		public EnumDropDown(Func<T, string> convertValueToString, ICollection<T> exclude = null)
+		{
+			this.convertValueToString = convertValueToString ?? throw new ArgumentNullException(nameof(convertValueToString));
+
+			var options = new List<Option<T>>();
+
+			var type = typeof(T);
+			var values = Enum.GetValues(type).Cast<T>();
+
+			foreach (var value in values)
+			{
+				if (exclude != null && exclude.Contains(value))
+				{
+					continue;
+				}
+
+				options.Add(new Option<T>(convertValueToString(value), value));
+			}
+
+			Options = options;
+		}
+
+		public override void SetOptions(IEnumerable<T> options)
+		{
+			base.SetOptions(options.Select(x => new Option<T>(convertValueToString(x), x)));
+		}
+
+		public override IEnumerable<T> Values
+		{
+			get => base.Values;
+			set
+			{
+				if (value == null) throw new ArgumentNullException(nameof(value));
+				SetOptions(value.Select(x => new Option<T>(convertValueToString(x), x)));
+			}
+		}
+
+		private static string DefaultConversion(T value)
+		{
+			return value.GetDescription();
+		}
+	}
+}

InteractiveAutomationToolkit/Components/Generics/EnumRadioButtonList.cs

@@ -0,0 +1,97 @@
+namespace Skyline.DataMiner.Utils.InteractiveAutomationScript
+{
+	using System;
+	using System.Collections.Generic;
+	using System.ComponentModel;
+	using System.Linq;
+
+	/// <summary>
+	/// A radio button list that allows users to select a value defined by an enum.
+	/// </summary>
+	/// <typeparam name="T">Enum type to represent with the radio button list.</typeparam>
+	/// /// <example>
+	///	<code>
+	///	public enum Capitol
+	/// {
+	///		None,
+	///		Brussels,
+	///		[Description("Washington DC")]
+	///		WashingtonDc,
+	///		[Description("Buenos Aires")]
+	///		BuenosAires,
+	///		Lisbon,
+	///		Cairo,
+	///		Paris
+	/// }
+	///
+	/// var capitolRadioButtonList = new EnumRadioButtonList&lt;Capitol&gt;(new [] { Capitol.None });
+	/// Capitol selectedCapitol = capitolRadioButtonList.Selected;
+	/// capitolRadioButtonList.Changed += (s, e) =>
+	/// {
+	///		engine.Log($"Capitol changed from {e.Previous} to {e.Selected}");
+	///		selectedCapitol = e.Selected;
+	/// };
+	///	</code>
+	/// </example>
+	public class EnumRadioButtonList<T> : RadioButtonList<T> where T : struct, Enum
+	{
+		private readonly Func<T, string> convertValueToString;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="EnumRadioButtonList{T}"/>
+		/// </summary>
+		/// <param name="exclude">Values of the enum to exclude as options from the radio button list.</param>
+		/// <remarks>
+		/// The display value of the enum is determined by the presence of the <see cref="DescriptionAttribute"/>.
+		/// If this attribute isn't defined, the .ToString() representation is used.
+		/// </remarks>
+		public EnumRadioButtonList(ICollection<T> exclude = null) : this(DefaultConversion, exclude) { }
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="EnumRadioButtonList{T}"/>
+		/// </summary>
+		/// <param name="convertValueToString">Function to map the enum value to its string representation.</param>
+		/// <param name="exclude">Values of the enum to exclude as options from the radio button list.</param>
+		public EnumRadioButtonList(Func<T, string> convertValueToString, ICollection<T> exclude = null)
+		{
+			this.convertValueToString = convertValueToString ?? throw new ArgumentNullException(nameof(convertValueToString));
+
+			var options = new List<Option<T>>();
+
+			var type = typeof(T);
+			var values = Enum.GetValues(type).Cast<T>();
+
+			foreach (var value in values)
+			{
+				if (exclude != null && exclude.Contains(value))
+				{
+					continue;
+				}
+
+				options.Add(new Option<T>(convertValueToString(value), value));
+			}
+
+			Options = options;
+		}
+
+		public override void SetOptions(IEnumerable<T> options)
+		{
+			base.SetOptions(options.Select(x => new Option<T>(convertValueToString(x), x)));
+		}
+
+		public override IEnumerable<T> Values
+		{
+			get => base.Values;
+			set
+			{
+				if (value == null) throw new ArgumentNullException(nameof(value));
+				SetOptions(value.Select(x => new Option<T>(convertValueToString(x), x)));
+			}
+		}
+
+		private static string DefaultConversion(T value)
+		{
+			return value.GetDescription();
+		}
+	}
+}

InteractiveAutomationToolkit/Components/Generics/GenericCheckBoxList.cs

@@ -118,7 +118,6 @@ public virtual IEnumerable<T> Values
 		}
 
 		/// <inheritdoc/>
-		/// <param name="option">Option to add.</param>
 		/// <exception cref="ArgumentNullException">When options is null.</exception>
 		public void AddOption(Option<T> option)
 		{

InteractiveAutomationToolkit/Components/Generics/GenericDropDown.cs

@@ -188,7 +188,7 @@ public void SetOptions(IEnumerable<Option<T>> options)
 
 		/// <inheritdoc/>
 		/// <exception cref="ArgumentNullException">When options is null.</exception>
-		public void SetOptions(IEnumerable<T> options)
+		public virtual void SetOptions(IEnumerable<T> options)
 		{
 			if (options == null) throw new ArgumentNullException(nameof(options));
 			SetOptions(options.Select(x => new Option<T>(x)));

InteractiveAutomationToolkit/Components/Generics/GenericRadioButtonList.cs

@@ -231,7 +231,7 @@ public void SetOptions(IEnumerable<Option<T>> options)
 
 		/// <inheritdoc/>
 		/// <exception cref="ArgumentNullException">When options is null.</exception>
-		public void SetOptions(IEnumerable<T> options)
+		public virtual void SetOptions(IEnumerable<T> options)
 		{
 			if (options == null) throw new ArgumentNullException(nameof(options));
 			SetOptions(options.Select(x => new Option<T>(x)));

InteractiveAutomationToolkit/Dialogs/Dialog.cs

@@ -6,6 +6,7 @@
 	using System.Linq;
 
 	using Skyline.DataMiner.Automation;
+	using Skyline.DataMiner.Net.Exceptions;
 
 	/// <summary>
 	///     A dialog represents a single window that can be shown.
@@ -594,17 +595,30 @@ public void SetWidgetLayout(Widget widget, IWidgetLayout widgetLayout)
 		/// <param name="requireResponse">If the dialog expects user interaction.</param>
 		/// <remarks>Should only be used when you create your own event loop.</remarks>
 		public void Show(bool requireResponse = true)
-		{
-			UIBuilder uib = Build();
-			uib.RequireResponse = requireResponse;
+		{		
+			UIBuilder uiBuilder = Build();
+			uiBuilder.RequireResponse = requireResponse;
 
-			IUIResults uir = new WrappedUIResults(Engine.ShowUI(uib));
+			IUIResults uiResults;
 
-			if (requireResponse)
+			try
 			{
-				LoadChanges(uir);
-				RaiseResultEvents(uir);
+				uiResults = new WrappedUIResults(Engine.ShowUI(uiBuilder));
 			}
+			catch(InteractiveUserDetachedException)
+			{
+				throw;
+			}
+			catch (DataMinerException e)
+			{
+				throw new InvalidOperationException($"{nameof(IEngine)}.{nameof(Engine.ShowUI)} failed with {nameof(UIBuilder)} argument {uiBuilder}", e);
+			}
+
+			if (requireResponse)
+			{
+				LoadChanges(uiResults);
+				RaiseResultEvents(uiResults);
+			}	
 		}
 
 		/// <summary>

InteractiveAutomationToolkit/Extensions/EnumExtensions.cs

@@ -0,0 +1,18 @@
+namespace Skyline.DataMiner.Utils.InteractiveAutomationScript
+{
+	using System;
+	using System.ComponentModel;
+	using System.Linq;
+
+	internal static class EnumExtensions
+	{
+		public static string GetDescription(this Enum value)
+		{
+			var enumField = value.GetType().GetField(value.ToString()) ?? throw new InvalidOperationException($"Value '{value}' is not a valid enum value");
+
+			var attribute = enumField.GetCustomAttributes(typeof(DescriptionAttribute), false).SingleOrDefault() as DescriptionAttribute;
+
+			return attribute == null ? value.ToString() : attribute.Description;
+		}
+	}
+}