ToggleState Enumerated Type

  • Article

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

Syntax

typedef enum {
    ToggleState_Off,
    ToggleState_On,
    ToggleState_Indeterminate
} ToggleState;

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.

Enumerated Type Information

Header uiautomationcore.h
Minimum operating systems Windows XP

See Also

IToggleProvider::Toggle