AutomationPeer Class

May 11, 2014

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

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 methodAutomationPeerProvides initialization for base class values when they are called by the constructor of a derived class.
Top

  NameDescription
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEventsSourceGets 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 methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAcceleratorKeyGets the accelerator key combination for the object that is associated with the UI Automation peer.
Protected methodGetAcceleratorKeyCoreWhen overridden in a derived class, is called by GetAcceleratorKey.
Public methodGetAccessKeyGets the access key for the object that is associated with the automation peer.
Protected methodGetAccessKeyCoreWhen overridden in a derived class, is called by GetAccessKey.
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetAutomationControlTypeGets the control type for the object that is associated with the UI Automation peer.
Protected methodGetAutomationControlTypeCoreWhen overridden in a derived class, is called by GetAutomationControlType.
Public methodGetAutomationIdGets the AutomationId of the object that is associated with the automation peer.
Protected methodGetAutomationIdCoreWhen overridden in a derived class, is called by GetAutomationId.
Public methodGetBoundingRectangleGets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.
Protected methodGetBoundingRectangleCoreWhen overridden in a derived class, is called by GetBoundingRectangle.
Public methodGetChildrenGets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer.
Protected methodGetChildrenCoreWhen overridden in a derived class, is called by GetChildren.
Public methodGetClassNameGets the name of the control class that is associated with the peer.
Protected methodGetClassNameCoreWhen overridden in a derived class, is called by GetClassName.
Public methodGetClickablePointGets a Point on the object that is associated with the automation peer that responds to a mouse click.
Protected methodGetClickablePointCoreWhen overridden in a derived class, is called by GetClickablePoint.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetHelpTextGets text that describes the functionality of the control that is associated with the automation peer.
Protected methodGetHelpTextCoreWhen overridden in a derived class, is called by GetHelpText.
Public methodGetItemStatusGets text that conveys the visual status of the object that is associated with this automation peer.
Protected methodGetItemStatusCoreWhen overridden in a derived class, is called by GetItemStatus.
Public methodGetItemTypeGets a string that describes what kind of item an element represents.
Protected methodGetItemTypeCoreWhen overridden in a derived class, is called by GetItemType.
Public methodGetLabeledByGets the AutomationPeer for the UIElement that is targeted to the element.
Protected methodGetLabeledByCoreWhen overridden in a derived class, is called by GetLabeledBy.
Public methodGetLocalizedControlTypeGets 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 methodGetLocalizedControlTypeCoreWhen overridden in a derived class, is called by GetLocalizedControlType.
Public methodGetNameGets the value that the automation peer reports as the UI Automation Name for the associated control.
Protected methodGetNameCoreWhen overridden in a derived class, is called by GetName.
Public methodGetOrientationGets a value that indicates the explicit control orientation, if any.
Protected methodGetOrientationCoreWhen overridden in a derived class, is called by GetOrientation.
Public methodGetParentGets the AutomationPeer that is the parent of this AutomationPeer.
Public methodGetPatternWhen 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 methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodHasKeyboardFocusGets a value that indicates whether the object that is associated with this automation peer currently has keyboard focus.
Protected methodHasKeyboardFocusCoreWhen overridden in a derived class, is called by HasKeyboardFocus.
Public methodInvalidatePeerTriggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed.
Public methodIsContentElementGets a value that indicates whether the object that is associated with this automation peer contains data that is presented to the user.
Protected methodIsContentElementCoreWhen overridden in a derived class, is called by IsContentElement.
Public methodIsControlElementGets 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 methodIsControlElementCoreWhen overridden in a derived class, is called by IsControlElement.
Public methodIsEnabledGets a value that indicates whether the element associated with this automation peer supports interaction.
Protected methodIsEnabledCoreWhen overridden in a derived class, is called by IsEnabled.
Public methodIsKeyboardFocusableGets a value that indicates whether the element can accept keyboard focus.
Protected methodIsKeyboardFocusableCoreWhen overridden in a derived class, is called by IsKeyboardFocusable.
Public methodIsOffscreenGets a value that indicates whether an element is off the screen.
Protected methodIsOffscreenCoreWhen overridden in a derived class, is called by IsOffscreen.
Public methodIsPasswordGets a value that indicates whether the element contains sensitive content.
Protected methodIsPasswordCoreWhen overridden in a derived class, is called by IsPassword.
Public methodIsRequiredForFormGets a value that indicates whether the object that is associated with this peer must be completed on a form.
Protected methodIsRequiredForFormCoreWhen overridden in a derived class, is called by IsRequiredForForm.
Public methodStatic memberListenerExistsGets a value that indicates whether UI Automation is listening for the specified event.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPeerFromProviderGets an AutomationPeer for the specified IRawElementProviderSimple proxy.
Protected methodProviderFromPeerGets the IRawElementProviderSimple proxy for the specified AutomationPeer.
Public methodRaiseAutomationEventRaises an automation event.
Public methodRaisePropertyChangedEventRaises an event to notify the automation client of a changed property value.
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetFocusSets the keyboard focus on the object that is associated with this automation peer.
Protected methodSetFocusCoreWhen overridden in a derived class, is called by SetFocus.
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft