IMultipleViewProvider
IMultipleViewProvider
IMultipleViewProvider
IMultipleViewProvider
Interface
Definition
Exposes methods and properties to support Microsoft UI Automation client access to controls that provide, and are able to switch between, multiple representations of the same set of information or child controls. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.MultipleView.
public : interface IMultipleViewProviderpublic interface IMultipleViewProviderPublic Interface IMultipleViewProvider// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see MultipleView Control Pattern.
IMultipleViewProvider isn't implemented by any existing Windows Runtime automation peers. Notably, IMultipleViewProvider doesn't exist for SemanticZoom. The interface exists so that custom control authors can support the automation pattern in a custom control, and implement their automation support using the same Windows Runtime managed or C++ API as they use to define control logic or other automation support.
Use MultipleViewPatternIdentifiers if you want to reference the IGridProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.
Properties
CurrentView CurrentView CurrentView CurrentView
Gets the current control-specific view.
public : int CurrentView { get; }public int CurrentView { get; }Public ReadOnly Property CurrentView As int// This API is not available in Javascript.
- Value
- int int int int
The view identifier for the current view of the UI Automation element.
Methods
GetSupportedViews() GetSupportedViews() GetSupportedViews() GetSupportedViews()
Retrieves a collection of control-specific view identifiers.
public : int[] GetSupportedViews()public int[] GetSupportedViews()Public Function GetSupportedViews() As int[]// This API is not available in Javascript.
A collection of values that identifies the views available for a UI Automation element.
GetViewName(Int32) GetViewName(Int32) GetViewName(Int32) GetViewName(Int32)
Retrieves the name of a control-specific view.
public : PlatForm::String GetViewName(int viewId)public string GetViewName(Int32 viewId)Public Function GetViewName(viewId As Int32) As string// This API is not available in Javascript.
- viewId
- int Int32 Int32 Int32
The view identifier.
A localized name for the view.
SetCurrentView(Int32) SetCurrentView(Int32) SetCurrentView(Int32) SetCurrentView(Int32)
Sets the current control-specific view.
public : void SetCurrentView(int viewId)public void SetCurrentView(Int32 viewId)Public Function SetCurrentView(viewId As Int32) As void// This API is not available in Javascript.
- viewId
- int Int32 Int32 Int32
A view identifier.