AutomationPeer Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

Inheritance Hierarchy

System::Object
  System.Windows::DependencyObject
    System.Windows.Automation.Peers::AutomationPeer
      System.Windows.Automation.Peers::FrameworkElementAutomationPeer

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

Syntax

C++

No code example is currently available or this language may not be supported.

The AutomationPeer type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	EventsSource	Gets or sets an AutomationPeer that is reported to the automation client as a source for all the events that come from this AutomationPeer.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAcceleratorKey	Gets the accelerator key combination for the object that is associated with the UI Automation peer.
	GetAcceleratorKeyCore	When overridden in a derived class, is called by GetAcceleratorKey.
	GetAccessKey	Gets the access key for the object that is associated with the automation peer.
	GetAccessKeyCore	When overridden in a derived class, is called by GetAccessKey.
	GetAnimationBaseValue	Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetAutomationControlType	Gets the control type for the object that is associated with the UI Automation peer.
	GetAutomationControlTypeCore	When overridden in a derived class, is called by GetAutomationControlType.
	GetAutomationId	Gets the AutomationId of the object that is associated with the automation peer.
	GetAutomationIdCore	When overridden in a derived class, is called by GetAutomationId.
	GetBoundingRectangle	Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.
	GetBoundingRectangleCore	When overridden in a derived class, is called by GetBoundingRectangle.
	GetChildren	Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer.
	GetChildrenCore	When overridden in a derived class, is called by GetChildren.
	GetClassName	Gets the name of the control class that is associated with the peer.
	GetClassNameCore	When overridden in a derived class, is called by GetClassName.
	GetClickablePoint	Gets a Point on the object that is associated with the automation peer that responds to a mouse click.
	GetClickablePointCore	When overridden in a derived class, is called by GetClickablePoint.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHelpText	Gets text that describes the functionality of the control that is associated with the automation peer.
	GetHelpTextCore	When overridden in a derived class, is called by GetHelpText.
	GetItemStatus	Gets text that conveys the visual status of the object that is associated with this automation peer.
	GetItemStatusCore	When overridden in a derived class, is called by GetItemStatus.
	GetItemType	Gets a string that describes what kind of item an element represents.
	GetItemTypeCore	When overridden in a derived class, is called by GetItemType.
	GetLabeledBy	Gets the AutomationPeer for the UIElement that is targeted to the element.
	GetLabeledByCore	When overridden in a derived class, is called by GetLabeledBy.
	GetLocalizedControlType	Gets a localized string that represents the control type, for the control that is associated with this automation peer. The localized string parallels a AutomationControlType value.
	GetLocalizedControlTypeCore	When overridden in a derived class, is called by GetLocalizedControlType.
	GetName	Gets the value that the automation peer reports as the UI Automation Name for the associated control.
	GetNameCore	When overridden in a derived class, is called by GetName.
	GetOrientation	Gets a value that indicates the explicit control orientation, if any.
	GetOrientationCore	When overridden in a derived class, is called by GetOrientation.
	GetParent	Gets the AutomationPeer that is the parent of this AutomationPeer.
	GetPattern	When overridden in a derived class, gets an object that supports the requested pattern, based on PatternInterface input and the peer's implementation of known patterns.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	HasKeyboardFocus	Gets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus.
	HasKeyboardFocusCore	When overridden in a derived class, is called by HasKeyboardFocus.
	InvalidatePeer	Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed.
	IsContentElement	Gets a value that indicates whether the object that is associated with this automation peer contains data that is presented to the user.
	IsContentElementCore	When overridden in a derived class, is called by IsContentElement.
	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.
	IsControlElementCore	When overridden in a derived class, is called by IsControlElement.
	IsEnabled	Gets a value that indicates whether the element associated with this automation peer supports interaction.
	IsEnabledCore	When overridden in a derived class, is called by IsEnabled.
	IsKeyboardFocusable	Gets a value that indicates whether the element can accept keyboard focus.
	IsKeyboardFocusableCore	When overridden in a derived class, is called by IsKeyboardFocusable.
	IsOffscreen	Gets a value that indicates whether an element is off the screen.
	IsOffscreenCore	When overridden in a derived class, is called by IsOffscreen.
	IsPassword	Gets a value that indicates whether the element contains sensitive content.
	IsPasswordCore	When overridden in a derived class, is called by IsPassword.
	IsRequiredForForm	Gets a value that indicates whether the object that is associated with this peer must be completed on a form.
	IsRequiredForFormCore	When overridden in a derived class, is called by IsRequiredForForm.
	ListenerExists	Gets a value that indicates whether UI Automation is listening for the specified event.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PeerFromProvider	Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.
	ProviderFromPeer	Gets the IRawElementProviderSimple proxy for the specified AutomationPeer.
	RaiseAutomationEvent	Raises an automation event.
	RaisePropertyChangedEvent	Raises an event to notify the automation client of a changed property value.
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetFocus	Sets the keyboard focus on the object that is associated with this automation peer.
	SetFocusCore	When overridden in a derived class, is called by SetFocus.
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)