ExpandCollapsePattern.ExpandCollapseStateProperty Field

 
System_CAPS_noteNote

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

Identifies the ExpandCollapseState property.

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

public static readonly AutomationProperty ExpandCollapseStateProperty

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

ExpandCollapseState refers to the visibility of immediate child objects only; it does not refer to the visibility of all descendant objects.

The default value is Expanded.

In the following example, a root element is passed to a function that returns a collection of UI 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="targetApp">
/// 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 targetApp)
{
    if (targetApp == null)
    {
        throw new ArgumentException("Root element cannot be null.");
    }

    PropertyCondition conditionLeafNode =
        new PropertyCondition(
        ExpandCollapsePattern.ExpandCollapseStateProperty, 
        ExpandCollapseState.LeafNode);

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

.NET Framework
Available since 3.0

ExpandCollapsePattern Class
System.Windows.Automation Namespace
InvokePattern and ExpandCollapsePattern Menu Item Sample

Return to top
Show: