ButtonAutomationPeer ButtonAutomationPeer ButtonAutomationPeer Class

Exposes Button types to Microsoft UI Automation.

Syntax

Declaration

public class ButtonAutomationPeerpublic class ButtonAutomationPeerPublic Class ButtonAutomationPeer

Inheritance Hierarchy

Inherited Members

Inherited methods

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Inherited properties

, ,

Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)
Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)
Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)

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.

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 summary

Initializes a new instance of the ButtonAutomationPeer class.

Methods summary

Sends a request to click the button associated with the automation peer.

Constructors

  • ButtonAutomationPeer(Button)
    ButtonAutomationPeer(Button)
    ButtonAutomationPeer(Button)
    ButtonAutomationPeer(Button)

    Initializes a new instance of the ButtonAutomationPeer class.

    public ButtonAutomationPeer(Button owner)public New(Button owner)Public Sub New(owner As Button)public ButtonAutomationPeer(Button owner)

    Parameters

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 voidpublic void Invoke()

    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.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ComposableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Automation.Peers.dll