MultipleViewPattern.CurrentViewProperty Field

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Identifies the CurrentView property.

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

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

 staticval mutable CurrentViewProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly CurrentViewProperty As AutomationProperty

Field Value

AutomationProperty

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>
'/ 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 Function FindAutomationElement( _
ByVal targetApp As AutomationElement) As AutomationElementCollection
    If targetApp Is Nothing Then
        Throw New ArgumentException("Root element cannot be null.")
    End If

    Dim conditionSupportsMultipleView As New PropertyCondition( _
    AutomationElement.IsMultipleViewPatternAvailableProperty, True)

    Return targetApp.FindAll( _
    TreeScope.Descendants, conditionSupportsMultipleView)

End Function 'FindAutomationElement

///--------------------------------------------------------------------
/// <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);
}

'/--------------------------------------------------------------------
'/ <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 Function GetCurrentViewProperty( _
ByVal multipleViewControl As AutomationElement) As Integer
    If multipleViewControl Is Nothing Then
        Throw New ArgumentNullException( _
        "AutomationElement parameter must not be null.")
    End If

    Return Fix(multipleViewControl.GetCurrentPropertyValue( _
    MultipleViewPattern.CurrentViewProperty))

End Function 'GetCurrentViewProperty

Remarks

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

Applies to

Jaa