AutomationPeer Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a base class that exposes an element to UI Automation.
public ref class AutomationPeer abstract : System::Windows::Threading::DispatcherObjectpublic abstract class AutomationPeer : System.Windows.Threading.DispatcherObjecttype AutomationPeer = class
inherit DispatcherObjectPublic MustInherit Class AutomationPeer
Inherits DispatcherObject- Inheritance
- Derived
Remarks
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.
Constructors
| AutomationPeer() |
Provides initialization for base class values when they are called by the constructor of a derived class. |
Properties
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| 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. |
| IsHwndHost |
Gets a value that indicates whether the element that is associated with this AutomationPeer hosts |
Methods
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetAcceleratorKey() |
Gets the accelerator key combinations for the element 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 element that is associated with the automation peer. |
| GetAccessKeyCore() |
When overridden in a derived class, is called by GetAccessKey(). |
| GetAutomationControlType() |
Gets the control type for the element 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 element 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 GetChildren() 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 a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. |
| GetClassNameCore() |
When overridden in a derived class, is called by GetClassName(). |
| GetClickablePoint() |
Gets a Point on the element that is associated with the automation peer that responds to a mouse click. |
| GetClickablePointCore() |
When overridden in a derived class, is called by GetClickablePoint(). |
| GetControlledPeers() |
Provides UI Automation with a list of elements affected or controlled by this AutomationPeer. |
| GetControlledPeersCore() |
When overridden in a derived class, provides UI Automation with a list of elements affected or controlled by this AutomationPeer. |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetHeadingLevel() | |
| GetHeadingLevelCore() | |
| 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(). |
| GetHostRawElementProviderCore() |
Tells UI Automation where in the UI Automation tree to place the |
| GetItemStatus() |
Gets text that conveys the visual status of the element 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 object represents. |
| GetItemTypeCore() |
When overridden in a derived class, is called by GetItemType(). |
| GetLabeledBy() |
Gets the AutomationPeer for the Label that is targeted to the element. |
| GetLabeledByCore() |
When overridden in a derived class, is called by GetLabeledBy(). |
| GetLiveSetting() |
Gets the notification characteristics of a live region that is associated with this automation peer. |
| GetLiveSettingCore() |
When overridden in a derived class, returns the notification characteristics of a live region. Called by the GetLiveSetting() method. |
| GetLocalizedControlType() |
Gets a human-readable localized string that represents the AutomationControlType value for the control that is associated with this automation peer. |
| GetLocalizedControlTypeCore() |
When overridden in a derived class, is called by GetLocalizedControlType(). |
| GetName() |
Gets text that describes the element that is associated with this automation peer. |
| 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(PatternInterface) |
When overridden in a derived class, gets the control pattern that is associated with the specified PatternInterface. |
| GetPeerFromPoint(Point) |
Gets an AutomationPeer from the specified point. |
| GetPeerFromPointCore(Point) |
When overridden in a derived class, is called from GetPeerFromPoint(Point). |
| GetPositionInSet() |
Attempts to get the value of the PositionInSet property. |
| GetPositionInSetCore() |
When overridden in a derived class, provides UI Automation with a one-based integer value that describes the position this element occupies in a group or set. |
| GetSizeOfSet() |
Attempts to get the value of the SizeOfSet property. |
| GetSizeOfSetCore() |
When overridden in a derived class, provides UI Automation with the size of the group or set that this element belongs to. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| HasKeyboardFocus() |
Gets a value that indicates whether the element 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 changed. |
| IsContentElement() |
Gets a value that indicates whether the element 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(). |
| IsDialog() | |
| IsDialogCore() | |
| 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 element that is associated with this peer must be completed on a form. |
| IsRequiredForFormCore() |
When overridden in a derived class, is called by IsRequiredForForm(). |
| ListenerExists(AutomationEvents) |
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(IRawElementProviderSimple) |
Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. |
| ProviderFromPeer(AutomationPeer) |
Gets the IRawElementProviderSimple for the specified AutomationPeer. |
| RaiseAsyncContentLoadedEvent(AsyncContentLoadedEventArgs) |
Called by the AutomationPeer to raise the AsyncContentLoadedEvent event. |
| RaiseAutomationEvent(AutomationEvents) |
Raises an automation event. |
| RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String) | |
| RaisePropertyChangedEvent(AutomationProperty, Object, Object) |
Raises an event to notify the automation client of a changed property value. |
| ResetChildrenCache() |
Synchronously resets the tree of child elements by calling GetChildrenCore(). |
| SetFocus() |
Sets the keyboard focus on the element that is associated with this automation peer. |
| SetFocusCore() |
When overridden in a derived class, is called by SetFocus(). |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
