MultipleViewPattern.CurrentViewProperty Field

Definition

Identifies the CurrentView property.

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

Field Value

Examples

In the following example, an integer is obtained that represents the current view for a control that supports MultipleViewPattern.

///--------------------------------------------------------------------
/// <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 conditionSupportsMultipleView =
        new PropertyCondition(
        AutomationElement.IsMultipleViewPatternAvailableProperty, true);

    return targetApp.FindAll(
        TreeScope.Descendants, conditionSupportsMultipleView);
}
///--------------------------------------------------------------------
/// <summary>
/// Gets the current view identifier from a target.
/// </summary>
/// <param name="multipleViewControl">
/// The current multiple view control.
/// </param>
/// <returns>
/// The current view identifier.
/// </returns>
///--------------------------------------------------------------------
private int GetCurrentViewProperty(
    AutomationElement multipleViewControl)
{
    if (multipleViewControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement parameter must not be null.");
    }

    return (int)multipleViewControl.GetCurrentPropertyValue(
        MultipleViewPattern.CurrentViewProperty);
}

Remarks

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

Applies to

Product Versions
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9