Export (0) Print
Expand All

MultipleViewPattern.SetCurrentView Method

Sets the current control-specific view.

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

public void SetCurrentView(
	int viewId
)

Parameters

viewId
Type: System.Int32

A control-specific view identifier.

ExceptionCondition
ArgumentException

viewId is not a member of the supported views collection.

View identifiers can be retrieved by using GetSupportedViews.

The control-specific collection of view identifiers is identical across instances.

In the following example, the collection of views available for a control that supports the MultipleViewPattern control pattern is retrieved. A member of the view identifiers collection is subsequently used to modify the current view of the control.

///-------------------------------------------------------------------- 
/// <summary> 
/// Sets the current view of a target. 
/// </summary> 
/// <param name="multipleViewControl">
/// The current multiple view control. 
/// </param> 
/// <param name="viewID">
/// The view identifier from the supported views collection. 
/// </param> 
///-------------------------------------------------------------------- 
private void SetView(AutomationElement multipleViewControl, int viewID)
{
    if (multipleViewControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement parameter must not be null.");
    }

    // Get a MultipleViewPattern from the current control.
    MultipleViewPattern multipleViewPattern = 
        GetMultipleViewPattern(multipleViewControl);

    if (multipleViewPattern != null)
    {
        try
        {
            multipleViewPattern.SetCurrentView(viewID);
        }
        // viewID is not a member of the supported views collection 
        catch (ArgumentException)
        {
            // TO DO: error handling
        }
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft