Set Checkbox State
Description
Selects or clears the specified checkbox UI element.
This activity might require an active display and an unlocked user session to successfully simulate interactions with UI components. For more detailed information, please refer to the relevant section in the Desktop Automation Notes.
Properties
Input
-
Automation Mode – Defines the method used to automate UI elements through hardware drivers or the Send Windows Messages API. The default option is Drivers.
Mode Description Drivers Leverages hardware drivers to simulate interactions directly with UI components. Requires an active display and unlocked user session. Window Messages Utilizes the Send Windows Messages API for automation, eliminating the need for an active display or unlocked session.
Note: This mode is compatible only with certain types of applications that support window message-based automation and may not work with others, such as WPF applications. -
Check Type – The state to be set on the specified checkbox. It holds one of the following values.
| Type | Description |
|---|---|
| CheckType.Check | Set the checkbox to checked state |
| CheckType.Uncheck | Set the checkbox to unchecked state |
| CheckType.Inverse | Inverse the checkbox state. It will uncheck if the current state is either checked or partially checked. It will check if the current state is unchecked. |
| CheckType.PartialCheck | Set the checkbox to partially checked state |
-
Delay After – Delay time, in milliseconds, after executing the activity. By default, it is set to 300 milliseconds.
-
Delay Before – Delay time, in milliseconds, before the activity begins execution. By default, it is set to 200 milliseconds.
-
Window Title – Holds the title of the window identified through Window Selector. You can also type in the title to identify the window for automation.
-
Window Instance - Holds the window instance identified through Window Selector. You can also type in the window instance for automation.
-
Search Parameters – Holds the information of the UI element identified through Element Selector.
Misc
-
DisplayName – The display name of the activity.
-
Private – If selected, the variables and argument values will no longer be logged at the Verbose level.
Optional
- Continue On Error – It Specifies whether the automation should continue even when the activity throws an error. If True, the activity continues without throwing any exceptions. If False, the activity throws an exception. The default value is False.
Note: If this activity is present inside the Try-Catch block, and the value of this property is True, no error would be caught.
Example
Download Example