IMultipleViewProvider.GetViewName Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Retrieves the name of a control-specific view.

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

Syntax

'Declaration
Function GetViewName ( _
    viewId As Integer _
) As String
string GetViewName(
    int viewId
)

Parameters

Return Value

Type: System.String
A localized name for the view.

Remarks

View identifiers can be retrieved by using GetSupportedViews.

The collection of view identifiers must be identical across instances.

View names must be suitable for use in text-to-speech, Braille, and other accessible applications.

A typical implementation pattern for the multiple view paradigm is to have some property on the owner control where UI automation is supported that exposes the possible views as a standard enumeration. Then, you map the integer values of that enumeration to the integers you report in the GetSupportedViews collection. GetViewName values would also correspond to the member names of the enumeration member with that value, at least when used with neutral or invariant culture.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.