AutomationPeer Class

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

'Declaration
Public MustInherit Class AutomationPeer _
    Inherits DependencyObject
public abstract class AutomationPeer : DependencyObject

The AutomationPeer type exposes the following members.

Constructors

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

Top

Properties

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

Top

Remarks

When UI Automation queries the root of a Silverlight application about an object, the root returns the UI Automation peer for that object. The peer also responds to UI Automation queries about its corresponding object.

Many (but not all) members of this class follow a pattern where the UI Automation system calls methods of this base class. The base class then accesses "Core" methods that are overridden by specific peer implementations. For this pattern, the matching method does nothing other than calling the "Core" method, and that "Core" method is left undefined in AutomationPeer. The derived FrameworkElementAutomationPeer overrides some of the "Core" methods to provide some practical defaults, but specific peers often override additional "Core" methods or override FrameworkElementAutomationPeer again to provide their specific automation peer behavior.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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