GridItemPattern.ContainingGridProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the ContainingGrid property.

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

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

 staticval mutable ContainingGridProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly ContainingGridProperty As AutomationProperty 

Field Value

AutomationProperty

Examples

In the following example, a root element is passed to a function that returns a collection of 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="targetApp">
/// The automation element from which to start searching.
/// </param>
/// <param name="targetControl">
/// The specific grid container of interest.
/// </param>
/// <returns>
/// A collection of automation elements satisfying 
/// the specified condition(s).
/// </returns>
///--------------------------------------------------------------------
private AutomationElementCollection FindAutomationElement(
    AutomationElement targetApp, AutomationElement targetControl)
{
    if (targetApp == null)
    {
        throw new ArgumentException("Root element cannot be null.");
    }

    PropertyCondition conditionSupportsGridItemPattern =
        new PropertyCondition(
        AutomationElement.IsGridItemPatternAvailableProperty, true);

    PropertyCondition conditionContainerGrid =
        new PropertyCondition(
        GridItemPattern.ContainingGridProperty, targetControl);

    AndCondition conditionGridItems =
        new AndCondition(
        conditionSupportsGridItemPattern,
        conditionContainerGrid);

    return targetApp.FindAll(
        TreeScope.Descendants, conditionGridItems);
}

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

    Dim conditionSupportsGridItemPattern As New PropertyCondition( _
    AutomationElement.IsGridItemPatternAvailableProperty, True)

    Dim conditionContainerGrid As New PropertyCondition( _
    GridItemPattern.ContainingGridProperty, targetControl)

    Dim conditionGridItems As New AndCondition( _
    conditionSupportsGridItemPattern, conditionContainerGrid)

    Return targetApp.FindAll(TreeScope.Descendants, conditionGridItems)

End Function 'FindAutomationElement

Remarks

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