🔹 AutomationPeer Class
namespace Noesis | MSDN
Represents a node in a Noesis view's automation tree.
A peer describes a UI element or data item to screen readers and other automation clients. Clients can navigate between peers, read properties such as name and control type, and use control patterns to perform actions such as invoking a button or selecting a list item.
To customize how a control is exposed to automation, override OnCreateAutomationPeer() in the control and return its peer.
Inheritance Hierarchy
• AutomationPeer
Properties
| Name | Description |
|---|---|
| ◆ AutomationControlType | Gets the control type for the element that is associated with the UI Automation peer |
| ◆ AutomationId | Gets the AutomationId of the element that is associated with the automation peer |
| ◆ BoundingRectangle | Gets the the screen coordinates of the element that is associated with the automation peer |
| ◆ Children | Gets the collection of elements that are represented in the UI Automation tree as immediate child elements of the automation peer |
| ◆ ClassName | Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer |
| ◆ ClickablePoint | Gets a Point on the element that is associated with the automation peer that responds to a mouse click |
| ◆ 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 |
| ◆ HelpText | Gets text that describes the functionality of the control that is associated with the automation peer |
| ◆ ItemStatus | Gets text that conveys the visual status of the element that is associated with this automation peer. |
| ◆ ItemType | Gets a string that describes what kind of item an object represents |
| ◆ LabeledBy | Gets the AutomationPeer for the Label that is targeted to the element |
| ◆ LiveSetting | Gets the notification characteristics of a live region that is associated with this automation peer |
| ◆ Name | Gets text that describes the element that is associated with this automation peer |
| ◆ Parent | Gets the AutomationPeer that is the parent of this AutomationPeer. |
| ◆ PositionInSet | Attempts to get the value of the PositionInSet property |
| ◆ SizeOfSet | Attempts to get the value of the SizeOfSet property |
| ◆ VisibleBoundingRectangle | Gets the visible part of bounding rectangle |
◆ Dependency Property ◆ Reflection Property
From DispatcherObject
| Name | Description |
|---|---|
| ◆ ThreadId | Gets the thread this DispatcherObject is associated with. Returns NoThreadId when this object is not attached to any thread. |
◆ Dependency Property ◆ Reflection Property
Attached Properties
AutomationPeer has no attached properties
Methods
| Name | Description |
|---|---|
| ◆ GetFirstChild() | Returns the first child in the automation tree, or nullptr if none is available. Call GetNextSibling() on each returned child to walk the children in order |
| ◆ GetFocusedPeer() | Call on an automation root to get the peer representing the view's keyboard focus Returns nullptr if no focused peer is connected to that root |
| ◆ GetLastChild() | Returns the last child in the automation tree, or nullptr if none is available. Call GetPreviousSibling() on each returned child to walk the children in reverse order |
| ◆ GetNextSibling() | Returns the next sibling in automation tree order, or nullptr if there is none |
| ◆ GetPattern(PatternInterface) | When overridden in a derived class, gets the control pattern that is associated with the specified PatternInterface |
| ◆ GetPeerFromPoint(const Point&) | Gets an AutomationPeer from the specified point |
| ◆ GetPreviousSibling() | Returns the previous sibling in automation tree order, or nullptr if there is none |
| ◆ HasKeyboardFocus() | Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus |
| ◆ 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. |
| ◆ 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 |
| ◆ IsElementAvailable() | Returns whether the element is available for operations such as reading its bounds or setting keyboard focus. Returns false if the element has been destroyed. A virtualized item may be temporarily unavailable. You can still find it through its container and call IVirtualizedItemProvider::Realize() before retrying. |
| ◆ IsEnabled() | Gets a value that indicates whether the element associated with this automation peer supports interaction |
| ◆ IsKeyboardFocusable() | Gets a value that indicates whether the element can accept keyboard focus |
| ◆ IsOffscreen() | Gets a value that indicates whether an element is off the screen |
| ◆ IsPassword() | Gets a value that indicates whether the element contains sensitive content |
| ◆ IsRequiredForForm() | Gets a value that indicates whether the element that is associated with this peer must be completed on a form |
| ◆ ListenerExists(AutomationEvent) | Returns true if a handler is subscribed to this event |
| ◆ RaiseAutomationEvent(AutomationEvent) | Raises an automation event |
| ◆ RaisePropertyChangedEvent(AutomationProperty, Variant, Variant) | Reports the old and new values of an automation property |
| ◆ ResetChildrenCache() | Refreshes the child list and parent links |
| ◆ SetFocus() | Sets the keyboard focus on the element that is associated with this automation peer |
| ◆ ValidateConnected(AutomationPeer*) | Call this before returning a peer to an accessibility client. Pass the root peer of the view or subtree you are exposing. Returns this peer if it belongs to that tree, or nullptr otherwise. A virtualized item can belong to the tree even when its visual container is unrealized. |
From DispatcherObject
| Name | Description |
|---|---|
| ◆ CheckAccess() | Determines whether the calling thread has access to this DispatcherObject |
| ◆ VerifyAccess() | Enforces that the calling thread has access to this DispatcherObject |
Events
AutomationPeer has no events