Edit

Share via

ToggleState Enum

  • Reference

Definition

Namespace:
System.Windows.Automation
Assembly:
UIAutomationTypes.dll

Contains values that specify the ToggleState of a UI Automation element.

public enum class ToggleState
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("ad7db4af-7166-4478-a402-ad5b77eab2fa")]
public enum ToggleState
public enum ToggleState
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("ad7db4af-7166-4478-a402-ad5b77eab2fa")>]
type ToggleState = 
type ToggleState = 
Public Enum ToggleState
Inheritance
Object
ValueType
Enum
ToggleState
Attributes
ComVisibleAttribute GuidAttribute

Fields

Name Value Description
Off 0

The UI Automation element is not selected, checked, marked, or otherwise activated.
On 1

The UI Automation element is selected, checked, marked, or otherwise activated.
Indeterminate 2

The UI Automation element is in an indeterminate state. Indeterminate 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.

Remarks

A control must cycle through its IToggleProvider.ToggleState in this order: On, Off, and, if supported, Indeterminate.

Applies to