Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
{
    get
    {
        return customControl.toggleStateColor[customControl.controlColor];;
    }
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.