IToggleProvider interface

Applies to Windows and Windows Phone

Exposes methods and properties to support Microsoft UI Automation client access to controls that can cycle through a set of states and maintain a particular state. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Toggle.

Syntax

Public Interface IToggleProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IToggleProvider interface has these types of members:

Methods

The IToggleProvider interface has these methods. It also inherits methods from the Object class.

MethodDescription
Toggle Cycles through the toggle states of a control.

 

Properties

The IToggleProvider interface has these properties.

PropertyAccess typeDescription

ToggleState

Read-onlyGets the toggle state of the control.

 

Remarks

Controls that do not maintain state when activated, such as buttons, toolbar buttons, and hyperlinks, must implement IInvokeProvider instead. The Toggle pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Toggle Control Pattern.

IToggleProvider is implemented by these existing Windows Runtime classes:

Use TogglePatternIdentifiers if you want to reference the IToggleProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

TogglePatternIdentifiers
IToggleProvider (COM interface)
Custom automation peers
Toggle Control Pattern

 

 

Show:
© 2014 Microsoft