Class CheckBoxList
- Namespace
- Skyline.DataMiner.Utils.InteractiveAutomationScript
- Assembly
- Skyline.DataMiner.Utils.InteractiveAutomationScriptToolkit.dll
A list of checkboxes.
public class CheckBoxList : InteractiveWidget- Inheritance
-
CheckBoxList
- Inherited Members
- Extension Methods
Constructors
- CheckBoxList()
Initializes a new instance of the CheckBoxList class.
- CheckBoxList(IEnumerable<string>)
Initializes a new instance of the CheckBoxList class.
Properties
- Checked
Gets all selected options.
- IsReadOnly
Gets or sets a value indicating whether the control is displayed in read-only mode. Read-only mode causes the widgets to appear read-write but the user won't be able to change their value. This only affects interactive scripts running in a web environment.
- IsSorted
Gets or sets a value indicating whether the options are sorted naturally.
- Options
Gets all options.
- Tooltip
Gets or sets the tooltip.
- Unchecked
Gets all options that are not selected.
- ValidationState
Gets or sets the state indicating if a given input field was validated or not and if the validation was valid. This should be used by the client to add a visual marker on the input field.
- ValidationText
Gets or sets the text that is shown if the validation state is invalid. This should be used by the client to add a visual marker on the input field. The validation text is not displayed for a checkbox list, but if this value is not explicitly set, the validation state will have no influence on the way the component is displayed.
Methods
- AddOption(string)
Adds an option to the checkbox list.
- Check(string)
Selects an option.
- CheckAll()
Selects all options.
- LoadResult(UIResults)
Load any changes made through user interaction.
- RaiseResultEvents()
Raises zero or more events of the widget. This method is called after LoadResult(UIResults) was called on all widgets.
- RemoveOption(string)
Removes an option from the checkbox list.
- SetOptions(IEnumerable<string>)
Sets the displayed options. Replaces existing options.
- Uncheck(string)
Clears an option.
- UncheckAll()
Clears all options.
Events
- Changed
Triggered when the state of a checkbox changes. WantsOnChange will be set to true when this event is subscribed to.