WindowPattern.IsTopmostProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the IsTopmost property.

public: static initonly System::Windows::Automation::AutomationProperty ^ IsTopmostProperty;

public static readonly System.Windows.Automation.AutomationProperty IsTopmostProperty;

 staticval mutable IsTopmostProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly IsTopmostProperty As AutomationProperty 

Field Value

AutomationProperty

Examples

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 AutomationElementCollection FindAutomationElement(
    AutomationElement rootElement)
{
    if (rootElement == null)
    {
        throw new ArgumentException("Root element cannot be null.");
    }

    PropertyCondition conditionCanMaximize = 
        new PropertyCondition(WindowPattern.CanMaximizeProperty, true);

    PropertyCondition conditionCanMinimize =
        new PropertyCondition(WindowPattern.CanMinimizeProperty, true);

    PropertyCondition conditionIsModal =
        new PropertyCondition(WindowPattern.IsModalProperty, false);

    PropertyCondition conditionIsTopmost =
        new PropertyCondition(WindowPattern.IsTopmostProperty, true);

    PropertyCondition conditionWindowInteractionState =
        new PropertyCondition(
        WindowPattern.WindowInteractionStateProperty, 
        WindowInteractionState.ReadyForUserInteraction);

    PropertyCondition conditionWindowVisualState =
        new PropertyCondition(
        WindowPattern.WindowVisualStateProperty, 
        WindowVisualState.Normal);

    // Use any combination of the preceding condtions to 
    // find the control(s) of interest
    Condition condition = new AndCondition(
        conditionCanMaximize, 
        conditionIsModal, 
        conditionWindowInteractionState);

    return rootElement.FindAll(TreeScope.Descendants, condition); 
}

'''------------------------------------------------------------------------
''' <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, _
        WindowInteractionState.ReadyForUserInteraction)

    Dim conditionWindowVisualState As _
        New PropertyCondition(WindowPattern.WindowVisualStateProperty, _
        WindowVisualState.Normal)

    ' 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

Remarks

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