ButtonAutomationPeer
ButtonAutomationPeer
ButtonAutomationPeer
ButtonAutomationPeer
Class
Definition
public : class ButtonAutomationPeer : ButtonBaseAutomationPeer, IButtonAutomationPeer, IInvokeProviderpublic class ButtonAutomationPeer : ButtonBaseAutomationPeer, IButtonAutomationPeer, IInvokeProviderPublic Class ButtonAutomationPeer Inherits ButtonBaseAutomationPeer Implements IButtonAutomationPeer, IInvokeProvider// This API is not available in Javascript.
- Inheritance
-
FrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerButtonAutomationPeerButtonAutomationPeerButtonAutomationPeerButtonAutomationPeer
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
The Windows Runtime Button class creates a new ButtonAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from ButtonAutomationPeer if you are deriving a custom class from Button and want to add automation support for additional features that you enabled in your custom class. Then override OnCreateAutomationPeer so that it returns your custom peer.
Default peer implementation and overrides in ButtonAutomationPeer
ButtonAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a Microsoft UI Automation client.
- GetPattern reports that the peer provides pattern support for PatternInterface.Invoke (IInvokeProvider ).
- GetClassName returns "Button".
- GetAutomationControlType returns AutomationControlType.Button.
- IsControlElement returns true. This peer has the immediate base class ButtonBaseAutomationPeer and inherits its behavior other than the overrides indicated above. Notably, GetName returns a string value based on examining the current Content. For more info, see ButtonBaseAutomationPeer.
The peer also has other behaviors that are provided by the base FrameworkElementAutomationPeer class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.
ButtonAutomationPeer derived classes
ButtonAutomationPeer is the parent class for AppBarButtonAutomationPeer.
Constructors
ButtonAutomationPeer(Button) ButtonAutomationPeer(Button) ButtonAutomationPeer(Button) ButtonAutomationPeer(Button)
Initializes a new instance of the ButtonAutomationPeer class.
public : ButtonAutomationPeer(Button owner)public ButtonAutomationPeer(Button owner)Public Sub New(owner As Button)// This API is not available in Javascript.
Methods
Invoke() Invoke() Invoke() Invoke()
Sends a request to click the button associated with the automation peer.
public : void Invoke()public void Invoke()Public Function Invoke() As void// This API is not available in Javascript.
Remarks
Calls to Invoke should return immediately without blocking. However, this behavior is entirely dependent on the Microsoft UI Automation provider implementation. In scenarios where calling Invoke causes a blocking issue, such as a modal dialog, a separate helper thread may be required to call the method.