SetCurrentView Method
Collapse the table of content
Expand the table of content

MultipleViewPattern.SetCurrentView Method (Int32)

 

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.

Exception Condition
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 MultipleViewPatterncontrol 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
Available since 3.0
Return to top
Show:
© 2016 Microsoft