Export (0) Print
Expand All

IToggleProvider.ToggleState Property

Gets the toggle state of the control.

Namespace:  System.Windows.Automation.Provider
Assembly:  UIAutomationProvider (in UIAutomationProvider.dll)

ToggleState ToggleState { get; }

Property Value

Type: System.Windows.Automation.ToggleState
The ToggleState of the control.

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

The following example shows an implementation of this method for a control that can be toggled. The ToggleState returned is based on the color of the control; this is analogous to the IsChecked property of a CheckBox control.

/// <summary> 
/// Retrieves the toggle state of the control. 
/// </summary> 
/// <remarks> 
/// For this custom control the toggle state is reflected by the color  
/// of the control. This is analogous to the CheckBox IsChecked property. 
/// Green   - ToggleState.On 
/// Red     - ToggleState.Off 
/// Yellow  - ToggleState.Indeterminate 
/// </remarks>
ToggleState IToggleProvider.ToggleState
        return customControl.toggleStateColor[customControl.controlColor];;

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
© 2015 Microsoft