IInvokeProvider Interface

  • Reference

Definition

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

Exposes a method to support Microsoft UI Automation access to controls that initiate or perform a single, unambiguous action and do not maintain state when activated. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Invoke.

public interface class IInvokeProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(4157710727, 45372, 17728, 176, 158, 103, 120, 226, 220, 155, 165)]
struct IInvokeProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(4157710727, 45372, 17728, 176, 158, 103, 120, 226, 220, 155, 165)]
public interface IInvokeProvider
Public Interface IInvokeProvider
Derived
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

An example of a control that meets the guidelines of IInvokeProvider is Button. Controls that do maintain state, such as check boxes and radio buttons, must instead implement IToggleProvider and ISelectionProvider respectively. Controls implement IInvokeProvider if the same behavior is not exposed through another control pattern provider. For more info on what this pattern is for, see Invoke Control Pattern.

IInvokeProvider is implemented by the existing Windows Runtime automation peers for Button (ButtonAutomationPeer), RepeatButton (RepeatButtonAutomationPeer) and HyperlinkButton (HyperlinkButtonAutomationPeer).

If you implement IInvokeProvider for a list/list items scenario and a control that uses ListViewBase, implement IInvokeProvider for the list and not for individual items.

The IInvokeProvider pattern doesn't have a pattern property identifier class, the only API to implement is Invoke, a method.

Methods

Invoke()

Sends a request to initiate or perform the single, unambiguous action of the provider control. For example, the invoke action for a Button is click.

Applies to

See also