TreeDataGrid Class

Definition

Namespace:Avalonia.Controls

Assembly:Avalonia.Controls.TreeDataGrid

Package:Avalonia.Controls.TreeDataGrid

Represents a control that displays hierarchical and tabular data together in a single view. It is a combination of a TreeView and DataGrid control.

public class TreeDataGrid

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> TemplatedControl -> TreeDataGrid

Remarks

The TreeDataGrid supports both flat (2D table) and hierarchical (tree with columns) layouts, making it suitable for a variety of data visualization needs.

Key features include:

• Supports both row selection and cell selection modes
• Column sorting capabilities
• Support for various column types (Text, CheckBox, Template)
• MVVM-first data model
• Drag and drop functionality for rows

Constructors

Name	Description
TreeDataGrid	Initializes a new instance of the Avalonia.Controls.TreeDataGrid class.

TreeDataGrid Constructor

Initializes a new instance of the Avalonia.Controls.TreeDataGrid class.

public TreeDataGrid()

Methods

Name	Description
AddHandler (2 overloads)	Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStyling	Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplate	Creates the visual children of the control, if necessary Inherited from TemplatedControl.
Arrange	Arranges the control and its children. Inherited from Layoutable.
BeginEdit	Begins editing the cell at the specified column and row indices.
BeginInit	Inherited from StyledElement.
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
BringRowIntoView	No summary available.
CancelEdit	Cancels the current cell edit, restoring the original value.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
CommitEdit	Commits the current cell edit.
EndInit	Inherited from StyledElement.
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
Focus	Focuses the control. Inherited from InputElement.
GetBaseValue	Inherited from AvaloniaObject.
GetFlowDirection	Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabled	Inherited from InputElement.
GetIsHoldWithMouseEnabled	Inherited from InputElement.
GetIsTemplateFocusTarget	Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
InvalidateArrange	Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasure	Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateVisual	Invalidates the visual and queues a repaint. Inherited from Visual.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
Measure	Carries out a measure of the control. Inherited from Layoutable.
RaiseEvent	Raises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)	Removes a handler for the specified routed event. Inherited from Interactive.
Render	Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirection	Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabled	Inherited from InputElement.
SetIsHoldWithMouseEnabled	Inherited from InputElement.
SetIsTemplateFocusTarget	Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetCell (2 overloads)	No summary available.
TryGetResource	Inherited from StyledElement.
TryGetRow (2 overloads)	No summary available.
TryGetRowModel	No summary available.
UpdateLayout	Executes a layout pass. Inherited from Layoutable.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

BeginEdit Method

Begins editing the cell at the specified column and row indices.

public bool BeginEdit(int columnIndex, int rowIndex)

Parameters

columnIndex int

The column index of the cell to edit.

rowIndex int

The row index of the cell to edit.

Returns

bool

true if the cell entered edit mode; otherwise, false.

BringRowIntoView Method

public Avalonia.Controls.Control BringRowIntoView(Avalonia.Controls.IndexPath index, Nullable<Avalonia.Rect> rect)

Parameters

index Avalonia.Controls.IndexPath

rect Nullable<Avalonia.Rect>

Returns

Avalonia.Controls.Control

CancelEdit Method

Cancels the current cell edit, restoring the original value.

public bool CancelEdit()

Returns

bool

true if an edit was cancelled; otherwise, false.

CommitEdit Method

Commits the current cell edit.

public bool CommitEdit()

Returns

bool

true if an edit was committed; otherwise, false.

TryGetCell overloads

TryGetCell Method

public bool TryGetCell(Avalonia.Controls.Control element, Avalonia.Controls.Primitives.TreeDataGridCell& result)

Parameters

element Avalonia.Controls.Control

result Avalonia.Controls.Primitives.TreeDataGridCell&

Returns

bool

TryGetCell Method

Attempts to retrieve a realized cell at the specified column and row indices.

public Avalonia.Controls.Control TryGetCell(int columnIndex, int rowIndex)

Parameters

columnIndex int

The index of the column.

rowIndex int

The index of the row.

Returns

Avalonia.Controls.Control

The cell at the specified indices, or null if no cell exists at that position.

Remarks

The row and column indices are based upon the data currently displayed in the TreeDataGrid, and not the underlying data source. For example, if the data is sorted, filtered or contains expanded hierarchical rows, the indices may not correspond directly to the data source. In addition, if the specified cell is not currently visible (e.g. scrolled out of view), this method will return null.

TryGetRow overloads

TryGetRow Method

public bool TryGetRow(Avalonia.Controls.Control element, Avalonia.Controls.Primitives.TreeDataGridRow& result)

Parameters

element Avalonia.Controls.Control

result Avalonia.Controls.Primitives.TreeDataGridRow&

Returns

bool

TryGetRow Method

Attempts to retrieve a realized row at the specified index.

public Avalonia.Controls.Primitives.TreeDataGridRow TryGetRow(int rowIndex)

Parameters

rowIndex int

The index of the row.

Returns

Avalonia.Controls.Primitives.TreeDataGridRow

The row at the specified index, or null if no row exists at that position.

Remarks

The row index is based upon the data currently displayed in the TreeDataGrid, and not the underlying data source. For example, if the data is sorted or filtered, the indices may not correspond directly to the data source. In addition, if the specified cell is not currently visible (e.g. scrolled out of view), this method will return null.

TryGetRowModel Method

public bool TryGetRowModel<TModel>(Avalonia.Controls.Control element, TModel& result)

Parameters

element Avalonia.Controls.Control

result TModel&

Type Parameters

TModel

Returns

bool

Properties

Name	Description
ActualThemeVariant	Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
AllowTriStateSorting	Gets or sets a value indicating whether the user can cycle through ascending, descending, and unsorted states when clicking the column header. The default is false.
AutoDragDropRows	Gets or sets a value indicating whether rows can be automatically dragged and dropped within the TreeDataGrid.
Background	Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizing	Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrush	Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThickness	Gets or sets the thickness of the control's border. Inherited from TemplatedControl.
Bounds	Gets the bounds of the control relative to its parent. Inherited from Visual.
CacheMode	Gets or sets the cache mode of the visual. Inherited from Visual.
CanUserResizeColumns	Gets or sets a value indicating whether users can resize columns.
CanUserSortColumns	Gets or sets a value indicating whether users can sort columns.
Classes	Gets or sets the styled element's classes. Inherited from StyledElement.
Clip	Gets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBounds	Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
ColumnHeadersPresenter	Gets the presenter that displays the column headers.
ColumnHeaderTheme	Gets or sets the theme applied to all column headers.
Columns	Gets the columns defined on the Avalonia.Controls.TreeDataGrid.
ContextFlyout	Gets or sets a context flyout to the control Inherited from Control.
ContextMenu	Gets or sets a context menu to the control. Inherited from Control.
CornerRadius	Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
Cursor	Gets or sets associated mouse cursor. Inherited from InputElement.
DataContext	Gets or sets the control's data context. Inherited from StyledElement.
DataTemplates	Gets or sets the data templates for the control. Inherited from Control.
DesiredSize	Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Effect	Gets or sets the effect of the control. Inherited from Visual.
ElementFactory	Gets the element factory used to create UI elements for the TreeDataGrid.
FlowDirection	Gets or sets the text flow direction. Inherited from Visual.
Focusable	Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
FocusAdorner	Gets or sets the control's focus adorner. Inherited from Control.
FontFamily	Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeatures	Gets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSize	Gets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretch	Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyle	Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeight	Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
Foreground	Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
FrozenColumnCount	Gets or sets the number of columns that are frozen on the left side.
GestureRecognizers	Inherited from InputElement.
GridLinesVisibility	Gets or sets a value indicating which grid lines are displayed between rows and columns.
HasMirrorTransform	Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
Height	Gets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignment	Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
IsArrangeValid	Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsEffectivelyEnabled	Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEffectivelyVisible	Gets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsEnabled	Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocused	Gets a value indicating whether the control is focused. Inherited from InputElement.
IsHitTestVisible	Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsInitialized	Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
IsKeyboardFocusWithin	Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsLoaded	Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
IsMeasureValid	Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
IsPointerOver	Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsTabStop	Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
IsVisible	Gets or sets a value indicating whether this control is visible. Inherited from Visual.
Item	Inherited from AvaloniaObject.
ItemsSource	Gets or sets the items source for the TreeDataGrid.
KeyBindings	Inherited from InputElement.
LetterSpacing	Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
Margin	Gets or sets the margin around the element. Inherited from Layoutable.
MaxHeight	Gets or sets the maximum height of the element. Inherited from Layoutable.
MaxWidth	Gets or sets the maximum width of the element. Inherited from Layoutable.
MinHeight	Gets or sets the minimum height of the element. Inherited from Layoutable.
MinWidth	Gets or sets the minimum width of the element. Inherited from Layoutable.
Name	Gets or sets the name of the styled element. Inherited from StyledElement.
Opacity	Gets or sets the opacity of the control. Inherited from Visual.
OpacityMask	Gets or sets the opacity mask of the control. Inherited from Visual.
Padding	Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
Parent	Gets the styled element's logical parent. Inherited from StyledElement.
RenderTransform	Gets or sets the render transform of the control. Inherited from Visual.
RenderTransformOrigin	Gets or sets the transform origin of the control. Inherited from Visual.
Resources	Gets or sets the styled element's resource dictionary. Inherited from StyledElement.
Rows	Gets the rows collection of the TreeDataGrid.
RowsPresenter	Gets the presenter that displays the rows.
RowTheme	Gets or sets the theme applied to all rows.
Scroll	Gets the scroll viewer that enables scrolling through the TreeDataGrid content.
Selection	Gets the selection model for the TreeDataGrid.
SelectionMode	Gets or sets the selection mode for the TreeDataGrid.
ShowColumnHeaders	Gets or sets a value indicating whether column headers should be displayed.
Source	Gets or sets the data source for the TreeDataGrid.
StyleKey	Gets the type by which the element is styled. Inherited from StyledElement.
Styles	Gets the styles for the styled element. Inherited from StyledElement.
TabIndex	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement.
Tag	Gets or sets a user-defined object attached to the control. Inherited from Control.
Template	Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
TemplatedParent	Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
Theme	Gets or sets the theme to be applied to the element. Inherited from StyledElement.
Transitions	Gets or sets the property transitions for the control. Inherited from Animatable.
UseLayoutRounding	Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignment	Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
Width	Gets or sets the width of the element. Inherited from Layoutable.
ZIndex	Gets or sets the Z index of the control. Inherited from Visual.

AllowTriStateSorting Property

Gets or sets a value indicating whether the user can cycle through ascending, descending, and unsorted states when clicking the column header. The default is false.

public bool AllowTriStateSorting { get; set; }

Remarks

When true, clicking a column header will cycle the sort order through ascending, descending, and unsorted. When false, clicking a column header will cycle the sort order through ascending and descending only.

This behavior only applies if Avalonia.Controls.TreeDataGrid.CanUserSortColumns is true. Individual columns can override this behavior via their Avalonia.Controls.TreeDataGridColumn.AllowTriStateSorting property.

AutoDragDropRows Property

Gets or sets a value indicating whether rows can be automatically dragged and dropped within the TreeDataGrid.

public bool AutoDragDropRows { get; set; }

Remarks

When enabled, users can reorder rows by dragging them to a new position. Changes will be reflected in the underlying data source. The default value is false.

CanUserResizeColumns Property

Gets or sets a value indicating whether users can resize columns.

public bool CanUserResizeColumns { get; set; }

Remarks

When true, users can adjust column widths by dragging the column dividers. The default value is true.

CanUserSortColumns Property

Gets or sets a value indicating whether users can sort columns.

public bool CanUserSortColumns { get; set; }

Remarks

When true, clicking on a column header will sort the data by that column. The default value is true.

ColumnHeadersPresenter Property

Gets the presenter that displays the column headers.

public Avalonia.Controls.Primitives.TreeDataGridColumnHeadersPresenter ColumnHeadersPresenter { get; set; }

Remarks

The column headers presenter is defined in the control template and is responsible for rendering the column headers at the top of the TreeDataGrid.

ColumnHeaderTheme Property

Gets or sets the theme applied to all column headers.

public Avalonia.Styling.ControlTheme ColumnHeaderTheme { get; set; }

Remarks

This theme controls the appearance of column header elements in the TreeDataGrid.

Columns Property

Gets the columns defined on the Avalonia.Controls.TreeDataGrid.

public Avalonia.Controls.TreeDataGridColumns Columns { get; set; }

Remarks

This property can be populated in XAML or read from the Avalonia.Controls.TreeDataGrid.Source.

ElementFactory Property

Gets the element factory used to create UI elements for the TreeDataGrid.

public Avalonia.Controls.Primitives.TreeDataGridElementFactory ElementFactory { get; set; }

Remarks

The element factory is responsible for creating the visual elements that represent rows, cells, and other components of the TreeDataGrid.

FrozenColumnCount Property

Gets or sets the number of columns that are frozen on the left side.

public int FrozenColumnCount { get; set; }

Remarks

Frozen columns do not scroll horizontally and remain visible at all times.

The default value is 0, meaning no columns are frozen. A value greater than the total column count will freeze all columns.

GridLinesVisibility Property

Gets or sets a value indicating which grid lines are displayed between rows and columns.

public Avalonia.Controls.TreeDataGridGridLinesVisibility GridLinesVisibility { get; set; }

Remarks

Horizontal grid lines are drawn between rows and vertical grid lines are drawn between columns. The default value is Avalonia.Controls.TreeDataGridGridLinesVisibility.None, meaning no grid lines are displayed.

Grid lines are drawn using the TreeDataGridLineBrush theme resource, which can be overridden to customize their color.

ItemsSource Property

Gets or sets the items source for the TreeDataGrid.

public System.Collections.IEnumerable ItemsSource { get; set; }

Remarks

When set, a Avalonia.Controls.FlatTreeDataGridSource<T> is automatically created using the XAML-defined Avalonia.Controls.TreeDataGrid.Columns and assigned to Avalonia.Controls.TreeDataGrid.Source.

This property is mutually exclusive with setting Avalonia.Controls.TreeDataGrid.Source directly.

Rows Property

Gets the rows collection of the TreeDataGrid.

public Avalonia.Controls.TreeDataGridRows Rows { get; set; }

Remarks

This property is automatically populated from the Avalonia.Controls.TreeDataGrid.Source.

RowsPresenter Property

Gets the presenter that displays the rows.

public Avalonia.Controls.Primitives.TreeDataGridRowsPresenter RowsPresenter { get; set; }

Remarks

The rows presenter is defined in the control template and is responsible for rendering the rows of data in the TreeDataGrid.

RowTheme Property

Gets or sets the theme applied to all rows.

public Avalonia.Styling.ControlTheme RowTheme { get; set; }

Remarks

This theme controls the appearance of row elements in the TreeDataGrid.

Scroll Property

Gets the scroll viewer that enables scrolling through the TreeDataGrid content.

public Avalonia.Controls.Primitives.IScrollable Scroll { get; set; }

Remarks

The scroll viewer is defined in the control template and provides vertical and horizontal scrolling capabilities for the TreeDataGrid.

Selection Property

Gets the selection model for the TreeDataGrid.

public Avalonia.Controls.Selection.TreeDataGridSelectionModel Selection { get; set; }

Remarks

To access the strongly-typed selection model, cast to the appropriate type. In the case where Avalonia.Controls.TreeDataGrid.Source is set, the selection model type is determined by the source. When Avalonia.Controls.TreeDataGrid.ItemsSource is set, the selection object will be a TreeDataGridRowSelectionModel<object> or a TreeDataGridCellSelectionModel<object> depending on Avalonia.Controls.TreeDataGrid.SelectionMode.

SelectionMode Property

Gets or sets the selection mode for the TreeDataGrid.

public Avalonia.Controls.TreeDataGridSelectionMode SelectionMode { get; set; }

Remarks

Note that this property cannot be set when Avalonia.Controls.TreeDataGrid.Source is set directly; the selection must be configured on the source itself in this case.

ShowColumnHeaders Property

Gets or sets a value indicating whether column headers should be displayed.

public bool ShowColumnHeaders { get; set; }

Remarks

The default value is true.

Source Property

Gets or sets the data source for the TreeDataGrid.

public Avalonia.Controls.TreeDataGridSource Source { get; set; }

Remarks

The source provides the data model, columns, and rows to be displayed in the TreeDataGrid.

Use Avalonia.Controls.FlatTreeDataGridSource<T> for flat data or Avalonia.Controls.HierarchicalTreeDataGridSource<T> for hierarchical data.

Fields

Name	Description
AllowTriStateSortingProperty	Defines the Avalonia.Controls.TreeDataGrid.AllowTriStateSorting property.
AutoDragDropRowsProperty	Defines the Avalonia.Controls.TreeDataGrid.AutoDragDropRows property.
BackgroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
BoundsProperty	Defines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModeProperty	Defines the Avalonia.Visual.CacheMode property. Inherited from Visual.
CanUserResizeColumnsProperty	Defines the Avalonia.Controls.TreeDataGrid.CanUserResizeColumns property.
CanUserSortColumnsProperty	Defines the Avalonia.Controls.TreeDataGrid.CanUserSortColumns property.
ClipProperty	Defines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsProperty	Defines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ColumnHeaderThemeProperty	Defines the Avalonia.Controls.TreeDataGrid.ColumnHeaderTheme property.
ColumnsProperty	Defines the Avalonia.Controls.TreeDataGrid.Columns property.
ContextCanceledEvent	Provides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutProperty	Defines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuProperty	Defines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEvent	Provides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CornerRadiusProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
CursorProperty	Gets or sets associated mouse cursor. Inherited from InputElement.
DataContextProperty	Defines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizeProperty	Defines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DoubleTappedEvent	Defines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
EffectProperty	Defines the Avalonia.Visual.Effect property. Inherited from Visual.
ElementFactoryProperty	Defines the Avalonia.Controls.TreeDataGrid.ElementFactory property.
FlowDirectionProperty	Defines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusableProperty	Defines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerProperty	Defines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
FontFamilyProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizeProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStyleProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
FrozenColumnCountProperty	Defines the Avalonia.Controls.TreeDataGrid.FrozenColumnCount property.
GettingFocusEvent	Defines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEvent	Defines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
GridLinesVisibilityProperty	Defines the Avalonia.Controls.TreeDataGrid.GridLinesVisibility property.
HasMirrorTransformProperty	Defines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightProperty	Defines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEvent	Defines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
IsEffectivelyEnabledProperty	Defines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledProperty	Defines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedProperty	Defines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisibleProperty	Defines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldingEnabledProperty	Defines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledProperty	Defines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinProperty	Defines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverProperty	Defines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopProperty	Defines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsTemplateFocusTargetProperty	Defines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
IsVisibleProperty	Defines the Avalonia.Visual.IsVisible property. Inherited from Visual.
ItemsSourceProperty	Defines the Avalonia.Controls.TreeDataGrid.ItemsSource property.
KeyDownEvent	Defines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEvent	Defines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LetterSpacingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
LoadedEvent	Defines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEvent	Defines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEvent	Defines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
MarginProperty	Defines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightProperty	Defines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthProperty	Defines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightProperty	Defines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthProperty	Defines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
NameProperty	Defines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
OpacityMaskProperty	Defines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityProperty	Defines the Avalonia.Visual.Opacity property. Inherited from Visual.
PaddingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
ParentProperty	Defines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEvent	Defines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEvent	Defines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEvent	Defines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEvent	Defines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEvent	Defines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEvent	Defines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEvent	Defines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEvent	Defines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEvent	Defines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEvent	Defines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEvent	Defines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RenderTransformOriginProperty	Defines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformProperty	Defines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEvent	Event raised when an element wishes to be scrolled into view. Inherited from Control.
RightTappedEvent	Defines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
RowDragOverEvent	Defines the Avalonia.Controls.TreeDataGrid.RowDragOver event.
RowDragStartedEvent	Defines the Avalonia.Controls.TreeDataGrid.RowDragStarted event.
RowDropEvent	Defines the Avalonia.Controls.TreeDataGrid.RowDrop event.
RowsProperty	Defines the Avalonia.Controls.TreeDataGrid.Rows property.
RowThemeProperty	Defines the Avalonia.Controls.TreeDataGrid.RowTheme property.
ScrollGestureEndedEvent	Defines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEvent	Defines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEvent	Defines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
ScrollProperty	Defines the Avalonia.Controls.TreeDataGrid.Scroll property.
SelectionModeProperty	Defines the Avalonia.Controls.TreeDataGrid.SelectionMode property.
ShowColumnHeadersProperty	Defines the Avalonia.Controls.TreeDataGrid.ShowColumnHeaders property.
SizeChangedEvent	Defines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SourceProperty	Defines the Avalonia.Controls.TreeDataGrid.Source property.
SwipeGestureEndedEvent	Defines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEvent	Defines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexProperty	Defines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagProperty	Defines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TappedEvent	Defines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplateAppliedEvent	Defines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatedParentProperty	Defines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TemplateProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
TextInputEvent	Defines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEvent	Defines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
ThemeProperty	Defines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsProperty	Defines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UnloadedEvent	Defines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseLayoutRoundingProperty	Defines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VisualParentProperty	Defines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthProperty	Defines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexProperty	Defines the Avalonia.Visual.ZIndex property. Inherited from Visual.

AllowTriStateSortingProperty Field

Defines the Avalonia.Controls.TreeDataGrid.AllowTriStateSorting property.

public Avalonia.StyledProperty<bool> AllowTriStateSortingProperty

AutoDragDropRowsProperty Field

Defines the Avalonia.Controls.TreeDataGrid.AutoDragDropRows property.

public Avalonia.StyledProperty<bool> AutoDragDropRowsProperty

CanUserResizeColumnsProperty Field

Defines the Avalonia.Controls.TreeDataGrid.CanUserResizeColumns property.

public Avalonia.StyledProperty<bool> CanUserResizeColumnsProperty

CanUserSortColumnsProperty Field

Defines the Avalonia.Controls.TreeDataGrid.CanUserSortColumns property.

public Avalonia.StyledProperty<bool> CanUserSortColumnsProperty

ColumnHeaderThemeProperty Field

Defines the Avalonia.Controls.TreeDataGrid.ColumnHeaderTheme property.

public Avalonia.StyledProperty<Avalonia.Styling.ControlTheme> ColumnHeaderThemeProperty

ColumnsProperty Field

Defines the Avalonia.Controls.TreeDataGrid.Columns property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGrid, Avalonia.Controls.TreeDataGridColumns> ColumnsProperty

ElementFactoryProperty Field

Defines the Avalonia.Controls.TreeDataGrid.ElementFactory property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGrid, Avalonia.Controls.Primitives.TreeDataGridElementFactory> ElementFactoryProperty

FrozenColumnCountProperty Field

Defines the Avalonia.Controls.TreeDataGrid.FrozenColumnCount property.

public Avalonia.StyledProperty<int> FrozenColumnCountProperty

GridLinesVisibilityProperty Field

Defines the Avalonia.Controls.TreeDataGrid.GridLinesVisibility property.

public Avalonia.StyledProperty<Avalonia.Controls.TreeDataGridGridLinesVisibility> GridLinesVisibilityProperty

ItemsSourceProperty Field

Defines the Avalonia.Controls.TreeDataGrid.ItemsSource property.

public Avalonia.StyledProperty<System.Collections.IEnumerable> ItemsSourceProperty

RowDragOverEvent Field

Defines the Avalonia.Controls.TreeDataGrid.RowDragOver event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TreeDataGridRowDragEventArgs> RowDragOverEvent

RowDragStartedEvent Field

Defines the Avalonia.Controls.TreeDataGrid.RowDragStarted event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TreeDataGridRowDragStartedEventArgs> RowDragStartedEvent

RowDropEvent Field

Defines the Avalonia.Controls.TreeDataGrid.RowDrop event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TreeDataGridRowDragEventArgs> RowDropEvent

RowsProperty Field

Defines the Avalonia.Controls.TreeDataGrid.Rows property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGrid, Avalonia.Controls.TreeDataGridRows> RowsProperty

RowThemeProperty Field

Defines the Avalonia.Controls.TreeDataGrid.RowTheme property.

public Avalonia.StyledProperty<Avalonia.Styling.ControlTheme> RowThemeProperty

ScrollProperty Field

Defines the Avalonia.Controls.TreeDataGrid.Scroll property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGrid, Avalonia.Controls.Primitives.IScrollable> ScrollProperty

SelectionModeProperty Field

Defines the Avalonia.Controls.TreeDataGrid.SelectionMode property.

public Avalonia.StyledProperty<Avalonia.Controls.TreeDataGridSelectionMode> SelectionModeProperty

ShowColumnHeadersProperty Field

Defines the Avalonia.Controls.TreeDataGrid.ShowColumnHeaders property.

public Avalonia.StyledProperty<bool> ShowColumnHeadersProperty

SourceProperty Field

Defines the Avalonia.Controls.TreeDataGrid.Source property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGrid, Avalonia.Controls.TreeDataGridSource> SourceProperty

Events

Name	Description
ActualThemeVariantChanged	Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTree	Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
AttachedToVisualTree	Raised when the control is attached to a rooted visual tree. Inherited from Visual.
CellClearing	Occurs when a cell is about to be cleared from the visual tree.
CellPrepared	Occurs when a cell has been prepared for display.
CellValueChanged	Occurs when a cell's value has changed.
ContextCanceled	Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequested	Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DataContextChanged	Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTree	Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
DetachedFromVisualTree	Raised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTapped	Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
EffectiveViewportChanged	Occurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocus	Occurs before the control receives focus. Inherited from InputElement.
GotFocus	Occurs when the control receives focus. Inherited from InputElement.
Holding	Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement.
Initialized	Occurs when the styled element has finished initialization. Inherited from StyledElement.
KeyDown	Occurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUp	Occurs when a key is released while the control has focus. Inherited from InputElement.
LayoutUpdated	Occurs when a layout pass completes for the control. Inherited from Layoutable.
Loaded	Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
LosingFocus	Occurs before the control loses focus. Inherited from InputElement.
LostFocus	Occurs when the control loses focus. Inherited from InputElement.
Pinch	Occurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEnded	Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement.
PointerCaptureLost	Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement.
PointerEntered	Occurs when the pointer enters the control. Inherited from InputElement.
PointerExited	Occurs when the pointer leaves the control. Inherited from InputElement.
PointerMoved	Occurs when the pointer moves over the control. Inherited from InputElement.
PointerPressed	Occurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleased	Occurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnify	Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotate	Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipe	Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChanged	Occurs when the mouse is scrolled over the control. Inherited from InputElement.
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGesture	Occurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEnded	Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
ResourcesChanged	Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTapped	Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement.
RowClearing	Occurs when a row is about to be cleared from the visual tree.
RowDragOver	Occurs when a drag operation is performed over a row.
RowDragStarted	Occurs when the user starts to drag a row.
RowDrop	Occurs when a drop operation is performed on a row.
RowPrepared	Occurs when a row has been prepared for display.
ScrollGesture	Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEnded	Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement.
ScrollGestureInertiaStarting	Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SelectionChanged	Occurs when the selection in the TreeDataGrid changes.
SelectionChanging	Occurs before the selection in the TreeDataGrid changes.
SizeChanged	Occurs when the bounds (actual size) of the control have changed. Inherited from Control.
SwipeGesture	Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEnded	Occurs when a swipe gesture ends on the control. Inherited from InputElement.
Tapped	Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement.
TemplateApplied	Raised when the control's template is applied. Inherited from TemplatedControl.
TextInput	Occurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequested	Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
Unloaded	Occurs when the control is removed from the visual tree. Inherited from Control.

CellClearing Event

Occurs when a cell is about to be cleared from the visual tree.

public event EventHandler<Avalonia.Controls.TreeDataGridCellEventArgs> CellClearing

Remarks

A cell is cleared when it is no longer needed for display, such as when it is scrolled out of view or when the data is removed from the data source. This event can be used to perform any necessary cleanup or state management before a cell is removed from the visual tree.

CellPrepared Event

Occurs when a cell has been prepared for display.

public event EventHandler<Avalonia.Controls.TreeDataGridCellEventArgs> CellPrepared

Remarks

A cell is prepared when it is created and bound to data for display. This event can be used to customize the appearance or behavior of the cell before it is rendered.

CellValueChanged Event

Occurs when a cell's value has changed.

public event EventHandler<Avalonia.Controls.TreeDataGridCellEventArgs> CellValueChanged

Remarks

This event is raised after the cell's value has been updated, either through user interaction or programmatically. It can be used to respond to changes in cell values, such as updating related data or triggering validation.

RowClearing Event

Occurs when a row is about to be cleared from the visual tree.

public event EventHandler<Avalonia.Controls.TreeDataGridRowEventArgs> RowClearing

Remarks

A row is cleared when it is no longer needed for display, such as when it is scrolled out of view or when the data is removed from the data source. This event can be used to perform any necessary cleanup or state management before a row is removed from the visual tree.

RowDragOver Event

Occurs when a drag operation is performed over a row.

public event EventHandler<Avalonia.Controls.TreeDataGridRowDragEventArgs> RowDragOver

RowDragStarted Event

Occurs when the user starts to drag a row.

public event EventHandler<Avalonia.Controls.TreeDataGridRowDragStartedEventArgs> RowDragStarted

RowDrop Event

Occurs when a drop operation is performed on a row.

public event EventHandler<Avalonia.Controls.TreeDataGridRowDragEventArgs> RowDrop

RowPrepared Event

Occurs when a row has been prepared for display.

public event EventHandler<Avalonia.Controls.TreeDataGridRowEventArgs> RowPrepared

Remarks

A row is prepared when it is created and bound to data for display. This event can be used to customize the appearance or behavior of the row before it is rendered.

SelectionChanged Event

Occurs when the selection in the TreeDataGrid changes.

public event EventHandler<Avalonia.Controls.Selection.TreeDataGridSelectionChangedEventArgs> SelectionChanged

Remarks

This event is forwarded from the underlying selection model's Avalonia.Controls.Selection.TreeDataGridSelectionModel.SelectionChanged event, providing unified event args with row and cell index information.

SelectionChanging Event

Occurs before the selection in the TreeDataGrid changes.

public event System.ComponentModel.CancelEventHandler SelectionChanging

Remarks

This event can be cancelled to prevent the selection from changing.