TreeDataGridRowHeaderColumn Class
Definition
A column that displays visual row numbers (0, 1, 2...).
public class TreeDataGridRowHeaderColumn
Remarks
The Avalonia.Controls.TreeDataGridRowHeaderColumn class provides a column type that displays visual row numbers. The numbers always represent the visual position of each row, remaining sequential regardless of sorting or whether the data source is flat or hierarchical.
This column type is designed to be explicitly added by users to their columns collection:
var source = new FlatTreeDataGridSource<Person>(people);
source.Columns.Add(new RowHeaderColumn());
source.Columns.Add(TextColumn.Create<Person, string>("Name", x => x.Name));
// Freeze the row header column if desired
treeDataGrid.FrozenColumnCount = 1;
Row header columns are read-only, do not support sorting, and are not user-resizable.
Constructors
| Name | Description |
|---|---|
| TreeDataGridRowHeaderColumn | Initializes a new instance of the Avalonia.Controls.TreeDataGridRowHeaderColumn class with default settings. |
TreeDataGridRowHeaderColumn Constructor
Initializes a new instance of the Avalonia.Controls.TreeDataGridRowHeaderColumn class with default settings.
public TreeDataGridRowHeaderColumn()
Remarks
Creates a row header column with no header text and a default width of 50 pixels.
Methods
| Name | Description |
|---|---|
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| 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. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| 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. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| ActualWidth | Gets the actual width of the column after measurement. Inherited from TreeDataGridColumn. |
| AllowTriStateSorting | Gets or sets whether the user can cycle through ascending, descending, and unsorted states when clicking the column header. Inherited from TreeDataGridColumn. |
| BeginEditGestures | Gets or sets the gesture(s) that will cause a cell to enter edit mode. Inherited from TreeDataGridColumn. |
| CanUserResize | Gets or sets a value indicating whether the user can resize the column by dragging. Inherited from TreeDataGridColumn. |
| CanUserSort | Gets or sets a value indicating whether the user can sort the column by clicking. Inherited from TreeDataGridColumn. |
| CellRenderer | Gets the cell renderer for this column, or null if the column uses control-based cells. Inherited from TreeDataGridColumn. |
| CompareAscending | Gets or sets a custom comparison for ascending sort order. Inherited from TreeDataGridColumn. |
| CompareDescending | Gets or sets a custom comparison for descending sort order. Inherited from TreeDataGridColumn. |
| Header | Gets or sets the column header. Inherited from TreeDataGridColumn. |
| IsVisible | Gets or sets a value indicating whether the column is visible. Inherited from TreeDataGridColumn. |
| MaxWidth | Gets or sets the maximum width for the column. Inherited from TreeDataGridColumn. |
| MinWidth | Gets or sets the minimum width for the column. Inherited from TreeDataGridColumn. |
| SortDirection | Gets or sets the sort direction indicator that will be displayed on the column. Inherited from TreeDataGridColumn. |
| Tag | Gets or sets a user-defined object attached to the column. Inherited from TreeDataGridColumn. |
| Width | Gets or sets the width of the column. Inherited from TreeDataGridColumn. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
Fields
Events
| Name | Description |
|---|---|
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |