TreeDataGridAutomationPeer Class

Definition

Namespace:Avalonia.Controls.Automation.Peers

Assembly:Avalonia.Controls.TreeDataGrid

Package:Avalonia.Controls.TreeDataGrid

An automation peer which represents a Avalonia.Controls.TreeDataGrid control.

public class TreeDataGridAutomationPeer

Inheritance: object -> AutomationPeer -> ControlAutomationPeer -> TreeDataGridAutomationPeer

Implements: IScrollProvider, ISelectionProvider

Remarks

Exposes the TreeDataGrid to UI Automation clients (screen readers and other assistive technologies) as a data grid. The peer surfaces the selection and scrolling patterns; the individual rows, cells and column headers are exposed by their own peers.

Constructors

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

TreeDataGridAutomationPeer Constructor

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

public TreeDataGridAutomationPeer(Avalonia.Controls.TreeDataGrid owner)

Parameters

owner Avalonia.Controls.TreeDataGrid

The Avalonia.Controls.TreeDataGrid being represented.

Methods

Name	Description
BringIntoView	Attempts to bring the element associated with the automation peer into view. Inherited from AutomationPeer.
CreatePeerForElement	Gets the Avalonia.Automation.Peers.AutomationPeer for a Avalonia.Controls.Control, creating it if necessary. Inherited from ControlAutomationPeer.
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.
GetSelection	Retrieves a provider for each child element that is selected.
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.
Scroll	Scrolls the visible region of the content area horizontally and vertically.
SetFocus	Sets the keyboard focus on the element that is associated with this automation peer. Inherited from AutomationPeer.
SetScrollPercent	Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.
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.

GetSelection Method

Retrieves a provider for each child element that is selected.

public System.Collections.Generic.IReadOnlyList<Avalonia.Automation.Peers.AutomationPeer> GetSelection()

Returns

System.Collections.Generic.IReadOnlyList<Avalonia.Automation.Peers.AutomationPeer>

Remarks

• WindowsISelectionProvider.GetSelection
• macOSNSAccessibilityProtocol.accessibilitySelectedChildren (not implemented).

Scroll Method

Scrolls the visible region of the content area horizontally and vertically.

public void Scroll(Avalonia.Automation.Provider.ScrollAmount horizontalAmount, Avalonia.Automation.Provider.ScrollAmount verticalAmount)

Parameters

horizontalAmount Avalonia.Automation.Provider.ScrollAmount

The horizontal increment specific to the control.

verticalAmount Avalonia.Automation.Provider.ScrollAmount

The vertical increment specific to the control.

Remarks

• WindowsIScrollProvider.Scroll
• macOSNo mapping.

SetScrollPercent Method

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

public void SetScrollPercent(double horizontalPercent, double verticalPercent)

Parameters

horizontalPercent double

The horizontal position as a percentage of the content area's total range. Avalonia.Automation.ScrollPatternIdentifiers.NoScroll should be passed in if the control cannot be scrolled in this direction.

verticalPercent double

The vertical position as a percentage of the content area's total range. Avalonia.Automation.ScrollPatternIdentifiers.NoScroll should be passed in if the control cannot be scrolled in this direction.

Remarks

• WindowsIScrollProvider.SetScrollPercent
• macOSNo mapping.

Properties

Name	Description
CanSelectMultiple	Gets a value that indicates whether the provider allows more than one child element to be selected concurrently.
HorizontallyScrollable	Gets a value that indicates whether the control can scroll horizontally.
HorizontalScrollPercent	Gets the current horizontal scroll position.
HorizontalViewSize	Gets the current horizontal view size.
IsSelectionRequired	Gets a value that indicates whether the provider requires at least one child element to be selected.
Owner	Gets the Avalonia.Controls.TreeDataGrid being represented.
VerticallyScrollable	Gets a value that indicates whether the control can scroll vertically.
VerticalScrollPercent	Gets the current vertical scroll position.
VerticalViewSize	Gets the vertical view size.

CanSelectMultiple Property

Gets a value that indicates whether the provider allows more than one child element to be selected concurrently.

public bool CanSelectMultiple { get; set; }

Remarks

• WindowsISelectionProvider.CanSelectMultiple
• macOSNo mapping.

HorizontallyScrollable Property

Gets a value that indicates whether the control can scroll horizontally.

public bool HorizontallyScrollable { get; set; }

Remarks

• WindowsIScrollProvider.HorizontallyScrollable
• macOSNo mapping.

HorizontalScrollPercent Property

Gets the current horizontal scroll position.

public double HorizontalScrollPercent { get; set; }

Remarks

• WindowsIScrollProvider.HorizontalScrollPercent
• macOSNo mapping.

HorizontalViewSize Property

Gets the current horizontal view size.

public double HorizontalViewSize { get; set; }

Remarks

• WindowsIScrollProvider.HorizontalViewSize
• macOSNo mapping.

IsSelectionRequired Property

Gets a value that indicates whether the provider requires at least one child element to be selected.

public bool IsSelectionRequired { get; set; }

Remarks

• WindowsISelectionProvider.IsSelectionRequired
• macOSNo mapping.

Owner Property

Gets the Avalonia.Controls.TreeDataGrid being represented.

public Avalonia.Controls.TreeDataGrid Owner { get; set; }

VerticallyScrollable Property

Gets a value that indicates whether the control can scroll vertically.

public bool VerticallyScrollable { get; set; }

Remarks

• WindowsIScrollProvider.VerticallyScrollable
• macOSNo mapping.

VerticalScrollPercent Property

Gets the current vertical scroll position.

public double VerticalScrollPercent { get; set; }

Remarks

• WindowsIScrollProvider.VerticalScrollPercent
• macOSNo mapping.

VerticalViewSize Property

Gets the vertical view size.

public double VerticalViewSize { get; set; }

Remarks

• WindowsIScrollProvider.VerticalViewSize
• macOSNo mapping.

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.