Export (0) Print
Expand All

TogglePattern.TogglePatternInformation.ToggleState Property

Retrieves the toggle state of the AutomationElement.

Namespace:  System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

'Declaration
Public ReadOnly Property ToggleState As ToggleState

Property Value

Type: System.Windows.Automation.ToggleState
The ToggleState of the AutomationElement. The default value is Indeterminate.

An AutomationElement must cycle through its ToggleState in this order: On, Off and, if supported, Indeterminate.

In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions.

'''-------------------------------------------------------------------- 
''' <summary> 
''' Finds all automation elements that satisfy  
''' the specified condition(s). 
''' </summary> 
''' <param name="rootElement"> 
''' The automation element from which to start searching. 
''' </param> 
''' <returns> 
''' A collection of automation elements satisfying  
''' the specified condition(s). 
''' </returns> 
'''-------------------------------------------------------------------- 
Private Function FindAutomationElement( _
ByVal rootElement As AutomationElement) As AutomationElementCollection
    If rootElement Is Nothing Then 
        Throw New ArgumentException("Root element cannot be null.")
    End If 

    Dim conditionOn As New PropertyCondition( _
    TogglePattern.ToggleStateProperty, ToggleState.On)

    Dim conditionIndeterminate As New PropertyCondition( _
    TogglePattern.ToggleStateProperty, ToggleState.Indeterminate)

    ' Use any combination of the preceding condtions to  
    ' find the control(s) of interest 
    Dim condition As OrCondition = _
    New OrCondition(conditionOn, conditionIndeterminate)

    Return rootElement.FindAll(TreeScope.Descendants, condition)

End Function 'FindAutomationElement    

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Show:
© 2014 Microsoft