MultipleViewPattern.MultipleViewPatternInformation.CurrentView Property

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Retrieves the current control-specific view.

C#

public int CurrentView { get; }

Property Value

Int32

The integer value for the current view of the AutomationElement. The default value is 0.

Examples

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

C#

///--------------------------------------------------------------------
/// <summary>
/// Obtains a MultipleViewPattern control pattern from an 
/// automation element.
/// </summary>
/// <param name="targetControl">
/// The automation element of interest.
/// </param>
/// <returns>
/// A MultipleViewPattern object.
/// </returns>
///--------------------------------------------------------------------
private MultipleViewPattern GetMultipleViewPattern(
    AutomationElement targetControl)
{
    MultipleViewPattern multipleViewPattern = null;

    try
    {
        multipleViewPattern =
            targetControl.GetCurrentPattern(
            MultipleViewPattern.Pattern)
            as MultipleViewPattern;
    }
    // Object doesn't support the MultipleViewPattern control pattern
    catch (InvalidOperationException)
    {
        return null;
    }

    return multipleViewPattern;
}

C#

///--------------------------------------------------------------------
/// <summary>
/// Gets the current view identifier from a target.
/// </summary>
/// <param name="multipleViewPattern">
/// The control pattern of interest.
/// </param>
/// <returns>
/// The current view identifier.
/// </returns>
///--------------------------------------------------------------------
private int GetCurrentViewFromPattern(
    MultipleViewPattern multipleViewPattern)
{
    if (multipleViewPattern == null)
    {
        throw new ArgumentNullException(
            "MultipleViewPattern parameter must not be null.");
    }

    return multipleViewPattern.Current.CurrentView;
}

Remarks

The collection of view identifiers is identical across instances.

Applies to