Skip to main content
AutomationPeer Class
 

Provides a base class that exposes an element to UI Automation. 

Namespace:   System.Windows.Automation.Peers
Assembly:  PresentationCore (in PresentationCore.dll)


public abstract class AutomationPeer : DispatcherObject
public ref class AutomationPeer abstract : DispatcherObject
[<AbstractClass>]
type AutomationPeer = 
    class
        inherit DispatcherObject
    end
Public MustInherit Class AutomationPeer
	Inherits DispatcherObject
NameDescription
System_CAPS_protmethod AutomationPeer

Provides initialization for base class values when they are called by the constructor of a derived class.

NameDescription
System_CAPS_pubproperty

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubproperty

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

System_CAPS_protproperty

Gets a value that indicates whether the element that is associated with this AutomationPeer hosts hwnds in Windows Presentation Foundation (WPF).

NameDescription
System_CAPS_pubmethod CheckAccess

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod GetAcceleratorKey

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

System_CAPS_protmethod GetAcceleratorKeyCore

When overridden in a derived class, is called by GetAcceleratorKey.

System_CAPS_pubmethod GetAccessKey

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

System_CAPS_protmethod GetAccessKeyCore

When overridden in a derived class, is called by GetAccessKey.

System_CAPS_pubmethod GetAutomationControlType

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

System_CAPS_protmethod GetAutomationControlTypeCore

When overridden in a derived class, is called by GetAutomationControlType.

System_CAPS_pubmethod GetAutomationId

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

System_CAPS_protmethod GetAutomationIdCore

When overridden in a derived class, is called by GetAutomationId.

System_CAPS_pubmethod GetBoundingRectangle

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

System_CAPS_protmethod GetBoundingRectangleCore

When overridden in a derived class, is called by GetBoundingRectangle.

System_CAPS_pubmethod GetChildren

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

System_CAPS_protmethod GetChildrenCore

When overridden in a derived class, is called by GetChildren.

System_CAPS_pubmethod GetClassName

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

System_CAPS_protmethod GetClassNameCore

When overridden in a derived class, is called by GetClassName.

System_CAPS_pubmethod GetClickablePoint

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

System_CAPS_protmethod GetClickablePointCore

When overridden in a derived class, is called by GetClickablePoint.

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetHelpText

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

System_CAPS_protmethod GetHelpTextCore

When overridden in a derived class, is called by GetHelpText.

System_CAPS_protmethod GetHostRawElementProviderCore

Tells UI Automation where in the UI Automation tree to place the hwnd being hosted by a Windows Presentation Foundation (WPF) element.

System_CAPS_pubmethod GetItemStatus

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

System_CAPS_protmethod GetItemStatusCore

When overridden in a derived class, is called by GetItemStatus.

System_CAPS_pubmethod GetItemType

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

System_CAPS_protmethod GetItemTypeCore

When overridden in a derived class, is called by GetItemType.

System_CAPS_pubmethod GetLabeledBy

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

System_CAPS_protmethod GetLabeledByCore

When overridden in a derived class, is called by GetLabeledBy.

System_CAPS_pubmethod GetLocalizedControlType

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

System_CAPS_protmethod GetLocalizedControlTypeCore

When overridden in a derived class, is called by GetLocalizedControlType.

System_CAPS_pubmethod GetName

Gets text that describes the element that is associated with this automation peer.

System_CAPS_protmethod GetNameCore

When overridden in a derived class, is called by GetName.

System_CAPS_pubmethod GetOrientation

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

System_CAPS_protmethod GetOrientationCore

When overridden in a derived class, is called by GetOrientation.

System_CAPS_pubmethod GetParent

Gets the AutomationPeer that is the parent of this AutomationPeer.

System_CAPS_pubmethod GetPattern

When overridden in a derived class, gets the control pattern that is associated with the specified PatternInterface.

System_CAPS_pubmethod GetPeerFromPoint

Gets an AutomationPeer from the specified point.

System_CAPS_protmethod GetPeerFromPointCore

When overridden in a derived class, is called from GetPeerFromPoint.

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod HasKeyboardFocus

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

System_CAPS_protmethod HasKeyboardFocusCore

When overridden in a derived class, is called by HasKeyboardFocus.

System_CAPS_pubmethod InvalidatePeer

Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the Automation Client if the properties changed.

System_CAPS_pubmethod IsContentElement

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

System_CAPS_protmethod IsContentElementCore

When overridden in a derived class, is called by IsContentElement.

System_CAPS_pubmethod 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.

System_CAPS_protmethod IsControlElementCore

When overridden in a derived class, is called by IsControlElement.

System_CAPS_pubmethod IsEnabled

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

System_CAPS_protmethod IsEnabledCore

When overridden in a derived class, is called by IsEnabled.

System_CAPS_pubmethod IsKeyboardFocusable

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

System_CAPS_protmethod IsKeyboardFocusableCore

When overridden in a derived class, is called by IsKeyboardFocusable.

System_CAPS_pubmethod IsOffscreen

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

System_CAPS_protmethod IsOffscreenCore

When overridden in a derived class, is called by IsOffscreen.

System_CAPS_pubmethod IsPassword

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

System_CAPS_protmethod IsPasswordCore

When overridden in a derived class, is called by IsPassword.

System_CAPS_pubmethod IsRequiredForForm

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

System_CAPS_protmethod IsRequiredForFormCore

When overridden in a derived class, is called by IsRequiredForForm.

System_CAPS_pubmethod System_CAPS_static ListenerExists

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

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod PeerFromProvider

Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.

System_CAPS_protmethod ProviderFromPeer

Gets the IRawElementProviderSimple for the specified AutomationPeer.

System_CAPS_pubmethod RaiseAsyncContentLoadedEvent

Called by the AutomationPeer to raise the AsyncContentLoadedEvent event.

System_CAPS_pubmethod RaiseAutomationEvent

Raises an automation event.

System_CAPS_pubmethod RaisePropertyChangedEvent

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

System_CAPS_pubmethod ResetChildrenCache

Synchronously resets the tree of child elements by calling GetChildrenCore.

System_CAPS_pubmethod SetFocus

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

System_CAPS_protmethod SetFocusCore

When overridden in a derived class, is called by SetFocus.

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethod VerifyAccess

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

When UI Automation queries the root of a Windows Presentation Foundation (WPF) application about an element, the root returns the UI Automation peer for that element. The peer also responds to UI Automation queries about its corresponding element.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top