AutomationPeer Class

Definition

Provides a base class that exposes the automation peer for an associated owner class to Microsoft UI Automation.

Equivalent WinUI class: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.

public ref class AutomationPeer : DependencyObject
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Automation.Peers.IAutomationPeerFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics3, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class AutomationPeer : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Automation.Peers.IAutomationPeerFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics3, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class AutomationPeer : DependencyObject
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics3), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class AutomationPeer : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics3), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Automation.Peers.IAutomationPeerStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public class AutomationPeer : DependencyObject
Public Class AutomationPeer
Inherits DependencyObject
Inheritance
AutomationPeer
Derived
Attributes

Windows 10 requirements

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

Remarks

AutomationPeer is the class that provides almost all of the API that eventually forwards the Microsoft UI Automation information for a UWP app using C++, C#, or Visual Basic to a Microsoft UI Automation client. Typical Microsoft UI Automation clients aren't calling AutomationPeer methods directly. These clients are often assistive technology that are using other programming models and operating as services, and are not likely to be calling Windows Runtime methods. But the general Microsoft UI Automation support in the Windows Runtime forwards all this information using the provider side of the Microsoft UI Automation framework. Any clients to Microsoft UI Automation can interact with the representative automation trees of a UWP app using C++, C#, or Visual Basic.

Firing automation events

The AutomationPeer class is relevant to Windows Runtime control authors because you will have a peer instance available at run time, after the runtime invokes the OnCreateAutomationPeer method. Using this peer, you can fire automation events by calling RaiseAutomationEvent and RaisePropertyChangedEvent. You would do this whenever a related property in the peer's owner (your class) changes, or when firing an event is needed for correct automation support.

The automation support design doesn't retain a handle to your own peer as part of how you implement OnCreateAutomationPeer, because there aren't any guarantees of when the peer is actually created. Instead, you can check for run-time automation event listeners inside your control class definitions just-in-time, using code like this:

if (AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged))
{
    MyAutomationPeer peer = 
        FrameworkElementAutomationPeer.FromElement(myCtrl) as MyAutomationPeer;

    if (peer != null)
    {
        peer.RaisePropertyChangedEvent(
            RangeValuePatternIdentifiers.ValueProperty,
            (double)oldValue,
            (double)newValue);
    }
}
If AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged) Then
    Dim peer As MyAutomationPeer = _
    TryCast(FrameworkElementAutomationPeer.FromElement(myCtrl), MyAutomationPeer)
    If peer IsNot Nothing Then
        peer.RaisePropertyChangedEvent(RangeValuePatternIdentifiers.ValueProperty, CDbl(oldValue), CDbl(newValue))
    End If
End If

AutomationPeer derived classes

AutomationPeer is in the hierarchy for all the existing peers for the Windows Runtime controls and related UI classes.

Classes that directly derive from AutomationPeer are:

Core methods

The "Core" methods are the standard implementations that perform the default action of an associated Microsoft UI Automation client-callable method. You can override any of the "Core" methods to return alternative values in a custom automation peer. For example, GetAcceleratorKeyCore is invoked any time that GetAcceleratorKey is called, GetAccessKeyCore is invoked any time that GetAccessKey is called, and so on.

The base implementation for AutomationPeer returns null. Peers that represent items may defer the result to their container.

Version history

Windows version SDK version Value added
1511 10586 GetLandmarkType
1511 10586 GetLandmarkTypeCore
1511 10586 GetLocalizedLandmarkType
1511 10586 GetLocalizedLandmarkTypeCore
1607 14393 GetDescribedByCore
1607 14393 GetFlowsFromCore
1607 14393 GetFlowsToCore
1607 14393 GetFullDescription
1607 14393 GetFullDescriptionCore
1607 14393 IsDataValidForForm
1607 14393 IsDataValidForFormCore
1607 14393 IsPeripheral
1607 14393 IsPeripheralCore
1703 15063 GetCulture
1703 15063 GetCultureCore
1709 16299 RaiseNotificationEvent
1803 17134 GetHeadingLevel
1803 17134 GetHeadingLevelCore
1809 17763 IsDialog
1809 17763 IsDialogCore

Constructors

AutomationPeer()

Provides base class initialization behavior for AutomationPeer derived classes.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.AutomationPeer.

Properties

Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
EventsSource

Gets or sets an AutomationPeer that is reported to the automation client as the source for all the events that come from this AutomationPeer. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.EventsSource.

Methods

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
GenerateRawElementProviderRuntimeId()

Generates a runtime identifier for the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GenerateRawElementProviderRuntimeId.

GetAcceleratorKey()

Gets the accelerator key combinations for the object that is associated with the UI Automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAcceleratorKey.

GetAcceleratorKeyCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAcceleratorKeyCore.

GetAccessKey()

Gets the access key for the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAccessKey.

GetAccessKeyCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAccessKeyCore.

GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetAnnotations()

Gets a reference to the list of UI automation annotations for the current automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAnnotations.

GetAnnotationsCore()

Provides the behavior of the peer when a Microsoft UI Automation client calls GetAnnotations or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAnnotationsCore.

GetAutomationControlType()

Gets the control type for the element that is associated with the UI Automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlType.

GetAutomationControlTypeCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlTypeCore.

GetAutomationId()

Gets the AutomationId of the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationId.

GetAutomationIdCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationIdCore.

GetBoundingRectangle()

Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetBoundingRectangle.

GetBoundingRectangleCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetBoundingRectangleCore.

GetChildren()

Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetChildren.

GetChildrenCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetChildrenCore.

GetClassName()

Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetClassName.

GetClassNameCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetClassNameCore.

GetClickablePoint()

Gets a point on the element that is associated with the automation peer that responds to a mouse click.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetClickablePoint.

GetClickablePointCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetClickablePointCore.

GetControlledPeers()

Provides the peer's behavior when a Microsoft UI Automation client calls GetControlledPeers or an equivalent Microsoft UI Automation client API such as getting a property value as identified by UIA_ControllerForPropertyId.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetControlledPeers.

GetControlledPeersCore()

Gets a list of the controlled peers for the current automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetControlledPeersCore.

GetCulture()

Calls GetCultureCore to get the culture value for the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetCulture.

GetCultureCore()

Gets the culture value for the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetCultureCore.

GetDescribedByCore()

Gets a collection of elements that provide more information about the automation element.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetDescribedByCore.

GetElementFromPoint(Point)

Gets an element from the specified point.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetElementFromPoint.

GetElementFromPointCore(Point)

Provides the behavior of the peer when a Microsoft UI Automation client calls GetElementFromPoint or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetElementFromPointCore.

GetFlowsFromCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsFrom or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsFromCore.

GetFlowsToCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsTo or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsToCore.

GetFocusedElement()

Gets the element that currently has the focus.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFocusedElement.

GetFocusedElementCore()

Provides the behavior of the peer when a Microsoft UI Automation client calls GetFocusedElement or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFocusedElementCore.

GetFullDescription()

Gets a localized string that describes the actual visual appearance or contents of something such as an image or image control.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFullDescription.

GetFullDescriptionCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetFullDescription or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetFullDescriptionCore.

GetHeadingLevel()

Gets the heading level of the UI Automation element that is associated with this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetHeadingLevel.

GetHeadingLevelCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetHeadingLevel or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetHeadingLevelCore.

GetHelpText()

Gets text that describes the functionality of the control that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetHelpText.

GetHelpTextCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetHelpTextCore.

GetItemStatus()

Gets text that conveys the visual status of the element that is associated with this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetItemStatus.

GetItemStatusCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetItemStatusCore.

GetItemType()

Gets a string that describes what kind of item an element represents.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetItemType.

GetItemTypeCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetItemTypeCore.

GetLabeledBy()

Gets the AutomationPeer for the UIElement that is targeted to the element.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLabeledBy.

GetLabeledByCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLabeledByCore.

GetLandmarkType()

Gets the landmark type for this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLandmarkType.

GetLandmarkTypeCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetLandmarkType or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLandmarkTypeCore.

GetLevel()

Returns the 1-based integer for the level (hierarchy) of the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLevel.

GetLevelCore()

Provides the behavior of the peer when a Microsoft UI Automation client calls GetLevel or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLevelCore.

GetLiveSetting()

Gets the live setting notification behavior information for the object that is associated with the UI Automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLiveSetting.

GetLiveSettingCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLiveSettingCore.

GetLocalizedControlType()

Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedControlType.

GetLocalizedControlTypeCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedControlTypeCore.

GetLocalizedLandmarkType()

Gets a localized string that represents the AutomationLandmarkType value for the element that is associated with this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedLandmarkType.

GetLocalizedLandmarkTypeCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedLandmarkType or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedLandmarkTypeCore.

GetName()

Gets text that describes the element that is associated with this automation peer. The Microsoft UI Automation Name value is the primary identifier used by most assistive technology when they represent your app's UI by interacting with the Microsoft UI Automation framework.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetName.

GetNameCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetNameCore.

GetOrientation()

Gets a value that indicates the explicit control orientation, if any.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetOrientation.

GetOrientationCore()

Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetOrientationCore.

GetParent()

Gets the AutomationPeer that is the parent of this AutomationPeer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetParent.

GetPattern(PatternInterface)

Gets the control pattern that is associated with the specified PatternInterface.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPattern.

GetPatternCore(PatternInterface)

Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPatternCore.

GetPeerFromPoint(Point)

Gets an AutomationPeer from the specified point.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPeerFromPoint.

GetPeerFromPointCore(Point)

Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPeerFromPointCore.

GetPositionInSet()

Returns the 1-based integer for the ordinal position in the set for the element that is associated with the automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPositionInSet.

GetPositionInSetCore()

Provides the peer’s behavior when a Microsoft UI Automation client calls GetPositionInSet or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetPositionInSetCore.

GetSizeOfSet()

Returns the 1-based integer for the size of the set where the element that is associated with the automation peer is located.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetSizeOfSet.

GetSizeOfSetCore()

Provides the peer’s behavior when a Microsoft UI Automation client calls GetSizeOfSet or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.GetSizeOfSetCore.

GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
HasKeyboardFocus()

Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.HasKeyboardFocus.

HasKeyboardFocusCore()

Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.HasKeyboardFocusCore.

InvalidatePeer()

Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.InvalidatePeer.

IsContentElement()

Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsContentElement.

IsContentElementCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsContentElementCore.

IsControlElement()

Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsControlElement.

IsControlElementCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsControlElementCore.

IsDataValidForForm()

Gets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsDataValidForForm.

IsDataValidForFormCore()

Provides the peer’s behavior when a Microsoft UI Automation client accesses IsDataValidForForm or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsDataValidForFormCore.

IsDialog()

Gets a value that indicates whether the element associated with this automation peer is a dialog window.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsDialog.

IsDialogCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsDialog or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsDialogCore.

IsEnabled()

Gets a value that indicates whether the element associated with this automation peer supports interaction.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsEnabled.

IsEnabledCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsEnabledCore.

IsKeyboardFocusable()

Gets a value that indicates whether the element can accept keyboard focus.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsKeyboardFocusable.

IsKeyboardFocusableCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsKeyboardFocusableCore.

IsOffscreen()

Gets a value that indicates whether an element is off the screen.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsOffscreen.

IsOffscreenCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsOffscreenCore.

IsPassword()

Gets a value that indicates whether the element contains sensitive content.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsPassword.

IsPasswordCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsPasswordCore.

IsPeripheral()

Gets a Boolean value that indicates whether the automation element represents peripheral UI.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsPeripheral.

IsPeripheralCore()

Provides the peer’s behavior when a Microsoft UI Automation client accesses IsPeripheral or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsPeripheralCore.

IsRequiredForForm()

Gets a value that indicates whether the element that is associated with this peer must be completed on a form.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsRequiredForForm.

IsRequiredForFormCore()

Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.IsRequiredForFormCore.

ListenerExists(AutomationEvents)

Gets a value that indicates whether Microsoft UI Automation reports that a client is listening for the specified event.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.ListenerExists.

Navigate(AutomationNavigationDirection)

Gets the element in the specified direction within the UI automation tree.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.Navigate.

NavigateCore(AutomationNavigationDirection)

Provides the peer’s behavior when a Microsoft UI Automation client calls Navigate or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.NavigateCore.

PeerFromProvider(IRawElementProviderSimple)

Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.PeerFromProvider.

ProviderFromPeer(AutomationPeer)

Gets the IRawElementProviderSimple proxy for the specified AutomationPeer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.ProviderFromPeer.

RaiseAutomationEvent(AutomationEvents)

Raises an automation event.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.RaiseAutomationEvent.

RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String)

Initiates a notification event.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.RaiseNotificationEvent.

RaisePropertyChangedEvent(AutomationProperty, Object, Object)

Raises an event to notify the automation client of a changed property value.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.RaisePropertyChangedEvent.

RaiseStructureChangedEvent(AutomationStructureChangeType, AutomationPeer)

Raises an event to notify the Microsoft UI Automation core that the tree structure has changed.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.RaiseStructureChangedEvent.

RaiseTextEditTextChangedEvent(AutomationTextEditChangeType, IReadOnlyList<String>)

Raises an event to notify the Microsoft UI Automation core that a text control has programmatically changed text.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent.

ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
SetFocus()

Sets the keyboard focus on the element that is associated with this automation peer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.SetFocus.

SetFocusCore()

Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.SetFocusCore.

SetParent(AutomationPeer)

Sets the AutomationPeer that is the parent of this AutomationPeer.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.SetParent.

SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
ShowContextMenu()

Shows the available context menu for the owner element.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.ShowContextMenu.

ShowContextMenuCore()

Provides the peer's behavior when a Microsoft UI Automation client calls ShowContextMenu or an equivalent Microsoft UI Automation client API.

Equivalent WinUI method: Microsoft.UI.Xaml.Automation.Peers.AutomationPeer.ShowContextMenuCore.

UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)

Applies to

See also