WindowPattern.IsModalProperty Field


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Identifies the IsModal property.

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

Public Shared ReadOnly IsModalProperty As AutomationProperty

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in WindowPatternIdentifiers.

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 conditionCanMaximize As _
        New PropertyCondition(WindowPattern.CanMaximizeProperty, True)

    Dim conditionCanMinimize As _
        New PropertyCondition(WindowPattern.CanMinimizeProperty, True)

    Dim conditionIsModal As _
        New PropertyCondition(WindowPattern.IsModalProperty, False)

    Dim conditionIsTopmost As _
        New PropertyCondition(WindowPattern.IsTopmostProperty, True)

    Dim conditionWindowInteractionState As _
        New PropertyCondition(WindowPattern.WindowInteractionStateProperty, _

    Dim conditionWindowVisualState As _
        New PropertyCondition(WindowPattern.WindowVisualStateProperty, _

    ' Use any combination of the preceding condtions to 
    ' find the control(s) of interest
    Dim condition = New AndCondition(conditionCanMaximize, _
        conditionIsModal, conditionWindowInteractionState)

    Return rootElement.FindAll(TreeScope.Descendants, condition)

End Function 'FindAutomationElement

.NET Framework
Available since 3.0
Return to top