Get Toggle State
Reads the current state of a checkbox, radio button or toggle button (Windows only). Uses the UIA TogglePattern; returns 'On', 'Off' or 'Indeterminate'.
Category: Desktop Application Automation · Group: Desktop · Activity name: GetToggleState
Example
outputVariable = GetToggleState("<xPath>", checkOrphanedElements=False)
Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| XPath | string | Yes | XPath expression that identifies the target element. | |
| Check orphaned elements | boolean | False | When the element is not found by its XPath, scan the parent window's area for elements detached from the UI Automation tree. Slower; enable only for windows known to orphan their elements. |
Outputs
| Name | Type | Description |
|---|---|---|
| outputVariable | string | Specifies the name of the variable that will store the toggle state ('On' / 'Off' / 'Indeterminate'). |