Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

AutomationPeer Class

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

Namespace:  System.Windows.Automation.Peers
Assembly:  System.Windows (in System.Windows.dll)
public abstract class AutomationPeer : DependencyObject

The AutomationPeer type exposes the following members.

  NameDescription
Protected methodSupported by Silverlight for Windows PhoneAutomationPeerProvides initialization for base class values when they are called by the constructor of a derived class.
Top
  NameDescription
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows PhoneEventsSourceGets or sets an AutomationPeer that is reported to the automation client as a source for all the events that come from this AutomationPeer.
Top
  NameDescription
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows 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 PhoneGetAcceleratorKeyGets the accelerator key combination for the object that is associated with the UI Automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetAcceleratorKeyCoreWhen overridden in a derived class, is called by GetAcceleratorKey.
Public methodSupported by Silverlight for Windows PhoneGetAccessKeyGets the access key for the object that is associated with the automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetAccessKeyCoreWhen overridden in a derived class, is called by GetAccessKey.
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns 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 PhoneGetAutomationControlTypeGets the control type for the object that is associated with the UI Automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetAutomationControlTypeCoreWhen overridden in a derived class, is called by GetAutomationControlType.
Public methodSupported by Silverlight for Windows PhoneGetAutomationIdGets the AutomationId of the object that is associated with the automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetAutomationIdCoreWhen overridden in a derived class, is called by GetAutomationId.
Public methodSupported by Silverlight for Windows PhoneGetBoundingRectangleGets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetBoundingRectangleCoreWhen overridden in a derived class, is called by GetBoundingRectangle.
Public methodSupported by Silverlight for Windows PhoneGetChildrenGets 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 PhoneGetChildrenCoreWhen overridden in a derived class, is called by GetChildren.
Public methodSupported by Silverlight for Windows PhoneGetClassNameGets the name of the control class that is associated with the peer.
Protected methodSupported by Silverlight for Windows PhoneGetClassNameCoreWhen overridden in a derived class, is called by GetClassName.
Public methodSupported by Silverlight for Windows PhoneGetClickablePointGets a Point on the object that is associated with the automation peer that responds to a mouse click.
Protected methodSupported by Silverlight for Windows PhoneGetClickablePointCoreWhen overridden in a derived class, is called by GetClickablePoint.
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetHelpTextGets text that describes the functionality of the control that is associated with the automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetHelpTextCoreWhen overridden in a derived class, is called by GetHelpText.
Public methodSupported by Silverlight for Windows PhoneGetItemStatusGets text that conveys the visual status of the object that is associated with this automation peer.
Protected methodSupported by Silverlight for Windows PhoneGetItemStatusCoreWhen overridden in a derived class, is called by GetItemStatus.
Public methodSupported by Silverlight for Windows PhoneGetItemTypeGets a string that describes what kind of item an element represents.
Protected methodSupported by Silverlight for Windows PhoneGetItemTypeCoreWhen overridden in a derived class, is called by GetItemType.
Public methodSupported by Silverlight for Windows PhoneGetLabeledByGets the AutomationPeer for the UIElement that is targeted to the element.
Protected methodSupported by Silverlight for Windows PhoneGetLabeledByCoreWhen overridden in a derived class, is called by GetLabeledBy.
Public methodSupported by Silverlight for Windows PhoneGetLocalizedControlTypeGets 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 PhoneGetLocalizedControlTypeCoreWhen overridden in a derived class, is called by GetLocalizedControlType.
Public methodSupported by Silverlight for Windows PhoneGetNameGets the value that the automation peer reports as the UI Automation Name for the associated control.
Protected methodSupported by Silverlight for Windows PhoneGetNameCoreWhen overridden in a derived class, is called by GetName.
Public methodSupported by Silverlight for Windows PhoneGetOrientationGets a value that indicates the explicit control orientation, if any.
Protected methodSupported by Silverlight for Windows PhoneGetOrientationCoreWhen overridden in a derived class, is called by GetOrientation.
Public methodSupported by Silverlight for Windows PhoneGetParentGets the AutomationPeer that is the parent of this AutomationPeer.
Public methodSupported by Silverlight for Windows PhoneGetPatternWhen 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 PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneHasKeyboardFocusGets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus.
Protected methodSupported by Silverlight for Windows PhoneHasKeyboardFocusCoreWhen overridden in a derived class, is called by HasKeyboardFocus.
Public methodSupported by Silverlight for Windows PhoneInvalidatePeerTriggers 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 PhoneIsContentElementGets 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 PhoneIsContentElementCoreWhen overridden in a derived class, is called by IsContentElement.
Public methodSupported by Silverlight for Windows PhoneIsControlElementGets 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 PhoneIsControlElementCoreWhen overridden in a derived class, is called by IsControlElement.
Public methodSupported by Silverlight for Windows PhoneIsEnabledGets a value that indicates whether the element associated with this automation peer supports interaction.
Protected methodSupported by Silverlight for Windows PhoneIsEnabledCoreWhen overridden in a derived class, is called by IsEnabled.
Public methodSupported by Silverlight for Windows PhoneIsKeyboardFocusableGets a value that indicates whether the element can accept keyboard focus.
Protected methodSupported by Silverlight for Windows PhoneIsKeyboardFocusableCoreWhen overridden in a derived class, is called by IsKeyboardFocusable.
Public methodSupported by Silverlight for Windows PhoneIsOffscreenGets a value that indicates whether an element is off the screen.
Protected methodSupported by Silverlight for Windows PhoneIsOffscreenCoreWhen overridden in a derived class, is called by IsOffscreen.
Public methodSupported by Silverlight for Windows PhoneIsPasswordGets a value that indicates whether the element contains sensitive content.
Protected methodSupported by Silverlight for Windows PhoneIsPasswordCoreWhen overridden in a derived class, is called by IsPassword.
Public methodSupported by Silverlight for Windows PhoneIsRequiredForFormGets 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 PhoneIsRequiredForFormCoreWhen overridden in a derived class, is called by IsRequiredForForm.
Public methodStatic memberSupported by Silverlight for Windows PhoneListenerExistsGets a value that indicates whether UI Automation is listening for the specified event.
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhonePeerFromProviderGets an AutomationPeer for the specified IRawElementProviderSimple proxy.
Protected methodSupported by Silverlight for Windows PhoneProviderFromPeerGets the IRawElementProviderSimple proxy for the specified AutomationPeer.
Public methodSupported by Silverlight for Windows PhoneRaiseAutomationEventRaises an automation event.
Public methodSupported by Silverlight for Windows PhoneRaisePropertyChangedEventRaises an event to notify the automation client of a changed property value.
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneSetFocusSets the keyboard focus on the object that is associated with this automation peer.
Protected methodSupported by Silverlight for Windows PhoneSetFocusCoreWhen overridden in a derived class, is called by SetFocus.
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

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

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.