ControlAutomationPeer Class
Definition
An automation peer which represents a Avalonia.Controls.Control element.
public class ControlAutomationPeer
Constructors
| Name | Description |
|---|---|
| ControlAutomationPeer | No summary available. |
ControlAutomationPeer Constructor
public ControlAutomationPeer(Avalonia.Controls.Control owner)
Parameters
Methods
| Name | Description |
|---|---|
| CreatePeerForElement | Gets the Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control, creating it if necessary. |
| FromElement | Gets an existing Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control. |
| GetOrCreate | No summary available. |
| BringIntoView | Attempts to bring the element associated with the automation peer into view. Inherited from AutomationPeer. |
| GetAcceleratorKey | Gets the accelerator key combinations for the element that is associated with the UI Automation peer. Inherited from AutomationPeer. |
| GetAccessKey | Gets the access key for the element that is associated with the automation peer. Inherited from AutomationPeer. |
| GetAutomationControlType | Gets the control type for the element that is associated with the UI Automation peer. Inherited from AutomationPeer. |
| GetAutomationId | Gets the automation ID of the element that is associated with the UI Automation peer. Inherited from AutomationPeer. |
| GetBoundingRectangle | Gets the bounding rectangle of the element that is associated with the automation peer in top-level coordinates. Inherited from AutomationPeer. |
| GetChildren | Gets the child automation peers. Inherited from AutomationPeer. |
| GetClassName | Gets a string that describes the class of the element. Inherited from AutomationPeer. |
| GetHeadingLevel | Gets the heading level that is associated with this automation peer. Inherited from AutomationPeer. |
| GetHelpText | Gets text that provides help for the element that is associated with this automation peer. Inherited from AutomationPeer. |
| GetItemStatus | Gets the item status that is associated with this automation peer. Inherited from AutomationPeer. |
| GetItemType | Gets the item type that is associated with this automation peer. Inherited from AutomationPeer. |
| GetLabeledBy | Gets the automation peer for the label that is targeted to the element. Inherited from AutomationPeer. |
| GetLandmarkType | Gets the control type for the element that is associated with the UI Automation peer. Inherited from AutomationPeer. |
| GetLiveSetting | Gets the current live setting that is associated with this this automation peer. Inherited from AutomationPeer. |
| GetLocalizedControlType | Gets a human-readable localized string that represents the type of the control that is associated with this automation peer. Inherited from AutomationPeer. |
| GetName | Gets text that describes the element that is associated with this automation peer. Inherited from AutomationPeer. |
| GetParent | Gets the Avalonia.Automation.Peers.AutomationPeer that is the parent of this Avalonia.Automation.Peers.AutomationPeer. Inherited from AutomationPeer. |
| GetPlaceholderText | Gets text that provides a placeholder for the element that is associated with this automation peer. Inherited from AutomationPeer. |
| GetProvider | Inherited from AutomationPeer. |
| HasKeyboardFocus | Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. Inherited from AutomationPeer. |
| IsContentElement | Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. Inherited from AutomationPeer. |
| 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. Inherited from AutomationPeer. |
| IsEnabled | Gets a value indicating whether the control is enabled for user interaction. Inherited from AutomationPeer. |
| IsKeyboardFocusable | Gets a value that indicates whether the element can accept keyboard focus. Inherited from AutomationPeer. |
| IsOffscreen | Gets a value that indicates whether an element is off the screen. Inherited from AutomationPeer. |
| RaisePropertyChangedEvent | Raises an event to notify the automation client of a changed property value. Inherited from AutomationPeer. |
| SetFocus | Sets the keyboard focus on the element that is associated with this automation peer. Inherited from AutomationPeer. |
| ShowContextMenu | Shows the context menu for the element that is associated with this automation peer. Inherited from AutomationPeer. |
CreatePeerForElement Method
Gets the Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control, creating it if necessary.
public Avalonia.Automation.Peers.AutomationPeer CreatePeerForElement(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control.
Returns
Avalonia.Automation.Peers.AutomationPeer
The automation peer.
Remarks
Despite the name (which comes from the analogous WPF API), this method does not create a new peer if one already exists: instead it returns the existing peer.
FromElement Method
Gets an existing Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control.
public Avalonia.Automation.Peers.AutomationPeer FromElement(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control.
Returns
Avalonia.Automation.Peers.AutomationPeer
The automation peer if already created; otherwise null.
Remarks
To ensure that a peer is created, use Avalonia.Automation.Peers.ControlAutomationPeer.CreatePeerForElement(Avalonia.Controls.Control).
GetOrCreate Method
public Avalonia.Automation.Peers.AutomationPeer GetOrCreate(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Returns
Properties
| Name | Description |
|---|---|
| Owner | No summary available. |
Owner Property
public Avalonia.Controls.Control Owner { get; set; }
Events
| Name | Description |
|---|---|
| ChildrenChanged | Occurs when the children of the automation peer have changed. Inherited from AutomationPeer. |
| PropertyChanged | Occurs when a property value of the automation peer has changed. Inherited from AutomationPeer. |