IToggleProvider Interface

Reference

Definition

Namespace:: Windows.UI.Xaml.Automation.Provider

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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.

public interface class IToggleProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2478342800, 25967, 17655, 174, 175, 120, 184, 249, 68, 208, 98)]
struct IToggleProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2478342800, 25967, 17655, 174, 175, 120, 184, 249, 68, 208, 98)]
public interface IToggleProvider

Public Interface IToggleProvider

Derived: Windows.UI.Xaml.Automation.Peers.AppBarAutomationPeer

Windows.UI.Xaml.Automation.Peers.SemanticZoomAutomationPeer

Windows.UI.Xaml.Automation.Peers.ToggleButtonAutomationPeer

Windows.UI.Xaml.Automation.Peers.ToggleMenuFlyoutItemAutomationPeer

Windows.UI.Xaml.Automation.Peers.ToggleSwitchAutomationPeer

More…

Attributes: ContractVersionAttribute GuidAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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:

AppBarAutomationPeer
SemanticZoomAutomationPeer
ToggleSwitchAutomationPeer
ToggleButtonAutomationPeer, which is the base class for RadioButtonAutomationPeer and CheckBoxAutomationPeer

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

Properties

ToggleState

Gets the toggle state of the control.

Methods

Toggle()

Cycles through the toggle states of a control.

Applies to