ButtonBaseAutomationPeer ButtonBaseAutomationPeer ButtonBaseAutomationPeer Class

Definition

Represents a base class for exposing classes derived from ButtonBase to Microsoft UI Automation.

public : class ButtonBaseAutomationPeer : FrameworkElementAutomationPeer, IButtonBaseAutomationPeer
public class ButtonBaseAutomationPeer : FrameworkElementAutomationPeer, IButtonBaseAutomationPeer
Public Class ButtonBaseAutomationPeer Inherits FrameworkElementAutomationPeer Implements IButtonBaseAutomationPeer
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

ButtonBaseAutomationPeer has a protected constructor, so you won't be able to use it directly for an OnCreateAutomationPeer definition. Derive your automation peer from ButtonBaseAutomationPeer if you are deriving a custom class from ButtonBase 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. Note that ButtonBase already has derived classes, each of which also has a derived peer, so make sure that you really want to derive from this base class rather than use one of the existing XAML-enabled derived button classes.

Default peer implementation and overrides in ButtonBaseAutomationPeer

ButtonAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a Microsoft UI Automation client.

There is no "ControlAutomationPeer" class. FrameworkElementAutomationPeer serves as implementation for all basic Control class scenarios that involve Microsoft UI Automation. This includes behavior that does not necessarily appear as a public API exposure, such as the practical implementations of many of the Core methods from AutomationPeer.

FrameworkElementAutomationPeer includes extensive base implementation of peer behavior that other peers can use to report information that comes from owner classes at the UIElement and FrameworkElement level. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.

In addition to the Core overrides, FrameworkElementAutomationPeer has two static utility methods that are useful for getting a peer handle from within control code, or for generating items peers from an item container peer for Microsoft UI Automation support. These are:

If you have a need to define a custom automation peer and can't identify a more derived peer class that pairs up with the control or base class you are deriving the owner class from, you should base your peer on FrameworkElementAutomationPeer. Even if the owner class isn't necessarily a FrameworkElement, you can't practically derive peers from AutomationPeer directly because FrameworkElementAutomationPeer has many overrides that provide the expected behavior for layout, automation and UI interactions. You do need to derive your owner class from UIElement at least, otherwise there is no way to create the peer on automation tree load with OnCreateAutomationPeer.

ButtonBaseAutomationPeer derived classes

ButtonBaseAutomationPeer is the parent class for several immediately derived classes that implement peer support for Windows Runtime controls. Here is the list of classes that directly derive from ButtonBaseAutomationPeer:

Constructors

ButtonBaseAutomationPeer(ButtonBase) ButtonBaseAutomationPeer(ButtonBase) ButtonBaseAutomationPeer(ButtonBase)

Provides base class initialization behavior for ButtonBase derived classes.

protected : ButtonBaseAutomationPeer(ButtonBase owner)
protected ButtonBaseAutomationPeer(ButtonBase owner)
Protected Sub New(owner As ButtonBase)
Parameters
owner
ButtonBase ButtonBase ButtonBase

The owner element to create for.

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

CreatePeerForElement(UIElement) CreatePeerForElement(UIElement) CreatePeerForElement(UIElement)

FromElement(UIElement) FromElement(UIElement) FromElement(UIElement)

GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId

Inherited from AutomationPeer

GetAcceleratorKey GetAcceleratorKey GetAcceleratorKey

Inherited from AutomationPeer

GetAcceleratorKeyCore GetAcceleratorKeyCore GetAcceleratorKeyCore

Inherited from AutomationPeer

GetAccessKey GetAccessKey GetAccessKey

Inherited from AutomationPeer

GetAccessKeyCore GetAccessKeyCore GetAccessKeyCore

Inherited from AutomationPeer

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetAnnotations GetAnnotations GetAnnotations

Inherited from AutomationPeer

GetAnnotationsCore GetAnnotationsCore GetAnnotationsCore

Inherited from AutomationPeer

GetAutomationControlType GetAutomationControlType GetAutomationControlType

Inherited from AutomationPeer

GetAutomationControlTypeCore GetAutomationControlTypeCore GetAutomationControlTypeCore

Inherited from AutomationPeer

GetAutomationId GetAutomationId GetAutomationId

Inherited from AutomationPeer

GetAutomationIdCore GetAutomationIdCore GetAutomationIdCore

Inherited from AutomationPeer

GetBoundingRectangle GetBoundingRectangle GetBoundingRectangle

Inherited from AutomationPeer

GetBoundingRectangleCore GetBoundingRectangleCore GetBoundingRectangleCore

Inherited from AutomationPeer

GetChildren GetChildren GetChildren

Inherited from AutomationPeer

GetChildrenCore GetChildrenCore GetChildrenCore

Inherited from AutomationPeer

GetClassName GetClassName GetClassName

Inherited from AutomationPeer

GetClassNameCore GetClassNameCore GetClassNameCore

Inherited from AutomationPeer

GetClickablePoint GetClickablePoint GetClickablePoint

Inherited from AutomationPeer

GetClickablePointCore GetClickablePointCore GetClickablePointCore

Inherited from AutomationPeer

GetControlledPeers GetControlledPeers GetControlledPeers

Inherited from AutomationPeer

GetControlledPeersCore GetControlledPeersCore GetControlledPeersCore

Inherited from AutomationPeer

GetCulture GetCulture GetCulture

Inherited from AutomationPeer

GetCultureCore GetCultureCore GetCultureCore

Inherited from AutomationPeer

GetDescribedByCore GetDescribedByCore GetDescribedByCore

Inherited from AutomationPeer

GetElementFromPoint(Point) GetElementFromPoint(Point) GetElementFromPoint(Point)

Inherited from AutomationPeer

GetElementFromPointCore(Point) GetElementFromPointCore(Point) GetElementFromPointCore(Point)

Inherited from AutomationPeer

GetFlowsFromCore GetFlowsFromCore GetFlowsFromCore

Inherited from AutomationPeer

GetFlowsToCore GetFlowsToCore GetFlowsToCore

Inherited from AutomationPeer

GetFocusedElement GetFocusedElement GetFocusedElement

Inherited from AutomationPeer

GetFocusedElementCore GetFocusedElementCore GetFocusedElementCore

Inherited from AutomationPeer

GetFullDescription GetFullDescription GetFullDescription

Inherited from AutomationPeer

GetFullDescriptionCore GetFullDescriptionCore GetFullDescriptionCore

Inherited from AutomationPeer

GetHelpText GetHelpText GetHelpText

Inherited from AutomationPeer

GetHelpTextCore GetHelpTextCore GetHelpTextCore

Inherited from AutomationPeer

GetItemStatus GetItemStatus GetItemStatus

Inherited from AutomationPeer

GetItemStatusCore GetItemStatusCore GetItemStatusCore

Inherited from AutomationPeer

GetItemType GetItemType GetItemType

Inherited from AutomationPeer

GetItemTypeCore GetItemTypeCore GetItemTypeCore

Inherited from AutomationPeer

GetLabeledBy GetLabeledBy GetLabeledBy

Inherited from AutomationPeer

GetLabeledByCore GetLabeledByCore GetLabeledByCore

Inherited from AutomationPeer

GetLandmarkType GetLandmarkType GetLandmarkType

Inherited from AutomationPeer

GetLandmarkTypeCore GetLandmarkTypeCore GetLandmarkTypeCore

Inherited from AutomationPeer

GetLevel GetLevel GetLevel

Inherited from AutomationPeer

GetLevelCore GetLevelCore GetLevelCore

Inherited from AutomationPeer

GetLiveSetting GetLiveSetting GetLiveSetting

Inherited from AutomationPeer

GetLiveSettingCore GetLiveSettingCore GetLiveSettingCore

Inherited from AutomationPeer

GetLocalizedControlType GetLocalizedControlType GetLocalizedControlType

Inherited from AutomationPeer

GetLocalizedControlTypeCore GetLocalizedControlTypeCore GetLocalizedControlTypeCore

Inherited from AutomationPeer

GetLocalizedLandmarkType GetLocalizedLandmarkType GetLocalizedLandmarkType

Inherited from AutomationPeer

GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore

Inherited from AutomationPeer

GetName GetName GetName

Inherited from AutomationPeer

GetNameCore GetNameCore GetNameCore

Inherited from AutomationPeer

GetOrientation GetOrientation GetOrientation

Inherited from AutomationPeer

GetOrientationCore GetOrientationCore GetOrientationCore

Inherited from AutomationPeer

GetParent GetParent GetParent

Inherited from AutomationPeer

GetPattern(PatternInterface) GetPattern(PatternInterface) GetPattern(PatternInterface)

Inherited from AutomationPeer

GetPatternCore(PatternInterface) GetPatternCore(PatternInterface) GetPatternCore(PatternInterface)

Inherited from AutomationPeer

GetPeerFromPoint(Point) GetPeerFromPoint(Point) GetPeerFromPoint(Point)

Inherited from AutomationPeer

GetPeerFromPointCore(Point) GetPeerFromPointCore(Point) GetPeerFromPointCore(Point)

Inherited from AutomationPeer

GetPositionInSet GetPositionInSet GetPositionInSet

Inherited from AutomationPeer

GetPositionInSetCore GetPositionInSetCore GetPositionInSetCore

Inherited from AutomationPeer

GetSizeOfSet GetSizeOfSet GetSizeOfSet

Inherited from AutomationPeer

GetSizeOfSetCore GetSizeOfSetCore GetSizeOfSetCore

Inherited from AutomationPeer

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

HasKeyboardFocus HasKeyboardFocus HasKeyboardFocus

Inherited from AutomationPeer

HasKeyboardFocusCore HasKeyboardFocusCore HasKeyboardFocusCore

Inherited from AutomationPeer

InvalidatePeer InvalidatePeer InvalidatePeer

Inherited from AutomationPeer

IsContentElement IsContentElement IsContentElement

Inherited from AutomationPeer

IsContentElementCore IsContentElementCore IsContentElementCore

Inherited from AutomationPeer

IsControlElement IsControlElement IsControlElement

Inherited from AutomationPeer

IsControlElementCore IsControlElementCore IsControlElementCore

Inherited from AutomationPeer

IsDataValidForForm IsDataValidForForm IsDataValidForForm

Inherited from AutomationPeer

IsDataValidForFormCore IsDataValidForFormCore IsDataValidForFormCore

Inherited from AutomationPeer

IsEnabled IsEnabled IsEnabled

Inherited from AutomationPeer

IsEnabledCore IsEnabledCore IsEnabledCore

Inherited from AutomationPeer

IsKeyboardFocusable IsKeyboardFocusable IsKeyboardFocusable

Inherited from AutomationPeer

IsKeyboardFocusableCore IsKeyboardFocusableCore IsKeyboardFocusableCore

Inherited from AutomationPeer

IsOffscreen IsOffscreen IsOffscreen

Inherited from AutomationPeer

IsOffscreenCore IsOffscreenCore IsOffscreenCore

Inherited from AutomationPeer

IsPassword IsPassword IsPassword

Inherited from AutomationPeer

IsPasswordCore IsPasswordCore IsPasswordCore

Inherited from AutomationPeer

IsPeripheral IsPeripheral IsPeripheral

Inherited from AutomationPeer

IsPeripheralCore IsPeripheralCore IsPeripheralCore

Inherited from AutomationPeer

IsRequiredForForm IsRequiredForForm IsRequiredForForm

Inherited from AutomationPeer

IsRequiredForFormCore IsRequiredForFormCore IsRequiredForFormCore

Inherited from AutomationPeer

ListenerExists(AutomationEvents) ListenerExists(AutomationEvents) ListenerExists(AutomationEvents)

Inherited from AutomationPeer

Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection)

Inherited from AutomationPeer

NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection)

Inherited from AutomationPeer

PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple)

Inherited from AutomationPeer

ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer)

Inherited from AutomationPeer

RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents)

Inherited from AutomationPeer

RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String)

Inherited from AutomationPeer

RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object)

Inherited from AutomationPeer

RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer)

Inherited from AutomationPeer

RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String})

Inherited from AutomationPeer

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

SetFocus SetFocus SetFocus

Inherited from AutomationPeer

SetFocusCore SetFocusCore SetFocusCore

Inherited from AutomationPeer

SetParent(AutomationPeer) SetParent(AutomationPeer) SetParent(AutomationPeer)

Inherited from AutomationPeer

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

ShowContextMenu ShowContextMenu ShowContextMenu

Inherited from AutomationPeer

ShowContextMenuCore ShowContextMenuCore ShowContextMenuCore

Inherited from AutomationPeer

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

Properties

Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

EventsSource EventsSource EventsSource

Inherited from AutomationPeer

Owner Owner Owner

See Also