ToggleState Enumeration

Contains values that specify the toggle state of a Microsoft UI Automation element that implements the Toggle control pattern.

Syntax

typedef enum ToggleState {
  ToggleState_Off,
  ToggleState_On,
  ToggleState_Indeterminate
} ;

Constants

ToggleState_Off The UI Automation element is not selected, checked, marked or otherwise activated.
ToggleState_On The UI Automation element is selected, checked, marked or otherwise activated.
ToggleState_Indeterminate The UI Automation element is in an indeterminate state.

The Indeterminate property can be used to indicate whether the user has acted on a control. For example, a check box can appear checked and dimmed, indicating an indeterminate state.

Creating an indeterminate state is different from disabling the control. Consequently, a check box in the indeterminate state can still receive the focus. When the user clicks an indeterminate control the ToggleState cycles to its next value.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header uiautomationcore.h (include UIAutomation.h)

See Also

Toggle