TreeDataGridRowAutomationPeer Class

Definition

Namespace:Avalonia.Controls.Automation.Peers

Assembly:Avalonia.Controls.TreeDataGrid

Package:Avalonia.Controls.TreeDataGrid

An automation peer which represents a Avalonia.Controls.Primitives.TreeDataGridRow.

public class TreeDataGridRowAutomationPeer

Inheritance: object -> AutomationPeer -> ControlAutomationPeer -> TreeDataGridRowAutomationPeer

Implements: IExpandCollapseProvider, ISelectionItemProvider

Remarks

Exposes a row to UI Automation clients. Rows in a hierarchical grid are reported as tree items and support the expand/collapse pattern; rows in a flat grid are reported as data items. In both cases the peer supports the selection-item pattern so a row can be selected.

Constructors

Name	Description
TreeDataGridRowAutomationPeer	Initializes a new instance of the Avalonia.Controls.Automation.Peers.TreeDataGridRowAutomationPeer class.

TreeDataGridRowAutomationPeer Constructor

Initializes a new instance of the Avalonia.Controls.Automation.Peers.TreeDataGridRowAutomationPeer class.

public TreeDataGridRowAutomationPeer(Avalonia.Controls.Primitives.TreeDataGridRow owner)

Parameters

owner Avalonia.Controls.Primitives.TreeDataGridRow

The Avalonia.Controls.Primitives.TreeDataGridRow being represented.

Methods

Name	Description
AddToSelection	Adds the current element to the collection of selected items.
BringIntoView	Attempts to bring the element associated with the automation peer into view. Inherited from AutomationPeer.
Collapse	Hides all nodes, controls, or content that are descendants of the control.
CreatePeerForElement	Gets the Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control, creating it if necessary. Inherited from ControlAutomationPeer.
Expand	Displays all child nodes, controls, or content of the control.
FromElement	Gets an existing Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control. Inherited from ControlAutomationPeer.
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.
GetOrCreate	Inherited from ControlAutomationPeer.
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.
RemoveFromSelection	Removes the current element from the collection of selected items.
Select	Clears any existing selection and then selects the current element.
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.
ToScreen	Converts a rectangle in the peer's coordinate space, as returned by Avalonia.Automation.Peers.AutomationPeer.GetBoundingRectangle, to screen coordinates; returns null if the peer is not currently hosted in a rendered visual tree. Inherited from AutomationPeer.

AddToSelection Method

Adds the current element to the collection of selected items.

public void AddToSelection()

Remarks

• WindowsISelectionItemProvider.AddToSelection
• macOSNSAccessibilityProtocol.accessibilityPerformPick (not implemented). NSAccessibilityProtocol.setAccessibilitySelected (not implemented).

Collapse Method

Hides all nodes, controls, or content that are descendants of the control.

public void Collapse()

Remarks

• WindowsIExpandCollapseProvider.Collapse
• macOS Called by setting NSAccessibilityProtocol.setAccessibilityExpanded to false.

Expand Method

Displays all child nodes, controls, or content of the control.

public void Expand()

Remarks

• WindowsIExpandCollapseProvider.Expand
• macOS Called by setting NSAccessibilityProtocol.setAccessibilityExpanded to true, by calling NSAccessibilityProtocol.accessibilityPerformPress, or by calling NSAccessibilityProtocol.accessibilityPerformShowMenu when Avalonia.Automation.Provider.IExpandCollapseProvider.ShowsMenu is true.

RemoveFromSelection Method

Removes the current element from the collection of selected items.

public void RemoveFromSelection()

Remarks

• WindowsISelectionItemProvider.RemoveFromSelection
• macOSNSAccessibilityProtocol.setAccessibilitySelected (not implemented).

Select Method

Clears any existing selection and then selects the current element.

public void Select()

Remarks

• WindowsISelectionItemProvider.Select
• macOSNo mapping.

Properties

Name	Description
ExpandCollapseState	Gets the state, expanded or collapsed, of the control.
IsSelected	Gets a value that indicates whether an item is selected.
Owner	Gets the Avalonia.Controls.Primitives.TreeDataGridRow being represented.
SelectionContainer	Gets the UI Automation provider that implements Avalonia.Automation.Provider.ISelectionProvider and acts as the container for the calling object.
ShowsMenu	Gets a value indicating whether expanding the element shows a menu of items to the user, such as drop-down list.

ExpandCollapseState Property

Gets the state, expanded or collapsed, of the control.

public Avalonia.Automation.ExpandCollapseState ExpandCollapseState { get; set; }

Remarks

• WindowsIExpandCollapseProvider.ExpandCollapseState
• macOSNSAccessibilityProtocol.isAccessibilityExpanded

IsSelected Property

Gets a value that indicates whether an item is selected.

public bool IsSelected { get; set; }

Remarks

• WindowsISelectionItemProvider.IsSelected
• macOSNSAccessibilityProtocol.isAccessibilitySelected

Owner Property

Gets the Avalonia.Controls.Primitives.TreeDataGridRow being represented.

public Avalonia.Controls.Primitives.TreeDataGridRow Owner { get; set; }

SelectionContainer Property

Gets the UI Automation provider that implements Avalonia.Automation.Provider.ISelectionProvider and acts as the container for the calling object.

public Avalonia.Automation.Provider.ISelectionProvider SelectionContainer { get; set; }

Remarks

• WindowsISelectionItemProvider.SelectionContainer
• macOSNo mapping.

ShowsMenu Property

Gets a value indicating whether expanding the element shows a menu of items to the user, such as drop-down list.

public bool ShowsMenu { get; set; }

Remarks

Used in OSX to allow accessibilityPerformShowMenu to open expandable controls such as a Avalonia.Controls.ComboBox; in macOS, a combo box drop-down is considered a menu.

• WindowsNo mapping.
• macOS When true, NSAccessibilityProtocol.accessibilityPerformShowMenu will cause the Avalonia.Automation.Provider.IExpandCollapseProvider.Expand method to be triggered.

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.