TreeDataGridColumn Class

Definition

Namespace:Avalonia.Controls

Assembly:Avalonia.Controls.TreeDataGrid

Package:Avalonia.Controls.TreeDataGrid

Base class for columns in a Avalonia.Controls.TreeDataGrid.

public class TreeDataGridColumn

Inheritance: object -> AvaloniaObject -> TreeDataGridColumn

Derived types: TreeDataGridBoundColumn, TreeDataGridHierarchicalExpanderColumn, TreeDataGridRowHeaderColumn, TreeDataGridTemplateColumn

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.
AllowTriStateSorting	Gets or sets whether the user can cycle through ascending, descending, and unsorted states when clicking the column header.
BeginEditGestures	Gets or sets the gesture(s) that will cause a cell to enter edit mode.
CanUserResize	Gets or sets a value indicating whether the user can resize the column by dragging.
CanUserSort	Gets or sets a value indicating whether the user can sort the column by clicking.
CellRenderer	Gets the cell renderer for this column, or null if the column uses control-based cells.
CompareAscending	Gets or sets a custom comparison for ascending sort order.
CompareDescending	Gets or sets a custom comparison for descending sort order.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Header	Gets or sets the column header.
HorizontalContentAlignment	Gets or sets the horizontal alignment of the content within a cell in the column.
IsVisible	Gets or sets a value indicating whether the column is visible.
Item	Inherited from AvaloniaObject.
MaxWidth	Gets or sets the maximum width for the column.
MinWidth	Gets or sets the minimum width for the column.
SortDirection	Gets or sets the sort direction indicator that will be displayed on the column.
Tag	Gets or sets a user-defined object attached to the column.
VerticalContentAlignment	Gets or sets the vertical alignment of the content within a cell in the column.
Width	Gets or sets the width of the column.

ActualWidth Property

Gets the actual width of the column after measurement.

public double ActualWidth { get; set; }

AllowTriStateSorting Property

Gets or sets whether the user can cycle through ascending, descending, and unsorted states when clicking the column header.

public Nullable<bool> AllowTriStateSorting { get; set; }

Remarks

Only applies if Avalonia.Controls.TreeDataGridColumn.CanUserSort is true. If null, the owner Avalonia.Controls.TreeDataGrid.AllowTriStateSorting property value will apply.

BeginEditGestures Property

Gets or sets the gesture(s) that will cause a cell to enter edit mode.

public Avalonia.Controls.BeginEditGestures BeginEditGestures { get; set; }

CanUserResize Property

Gets or sets a value indicating whether the user can resize the column by dragging.

public Nullable<bool> CanUserResize { get; set; }

Remarks

If null, the owner Avalonia.Controls.TreeDataGrid.CanUserResizeColumns property value will apply.

CanUserSort Property

Gets or sets a value indicating whether the user can sort the column by clicking.

public Nullable<bool> CanUserSort { get; set; }

Remarks

If null, the owner Avalonia.Controls.TreeDataGrid.CanUserSortColumns property value will apply.

CellRenderer Property

Gets the cell renderer for this column, or null if the column uses control-based cells.

public Avalonia.Controls.CellRenderer CellRenderer { get; set; }

Remarks

When a Avalonia.Controls.TreeDataGridColumn.CellRenderer is set, the column's cells are drawn directly by the Avalonia.Controls.Primitives.TreeDataGridCellsPresenter rather than by per-cell controls.

CompareAscending Property

Gets or sets a custom comparison for ascending sort order.

public Comparison<object> CompareAscending { get; set; }

CompareDescending Property

Gets or sets a custom comparison for descending sort order.

public Comparison<object> CompareDescending { get; set; }

Header Property

Gets or sets the column header.

public object Header { get; set; }

HorizontalContentAlignment Property

Gets or sets the horizontal alignment of the content within a cell in the column.

public Avalonia.Layout.HorizontalAlignment HorizontalContentAlignment { get; set; }

IsVisible Property

Gets or sets a value indicating whether the column is visible.

public bool IsVisible { get; set; }

Remarks

When set to false, the column header and cells will not be rendered and the column will not contribute to layout calculations.

MaxWidth Property

Gets or sets the maximum width for the column.

public Nullable<Avalonia.Controls.GridLength> MaxWidth { get; set; }

MinWidth Property

Gets or sets the minimum width for the column.

public Avalonia.Controls.GridLength MinWidth { get; set; }

SortDirection Property

Gets or sets the sort direction indicator that will be displayed on the column.

public Nullable<System.ComponentModel.ListSortDirection> SortDirection { get; set; }

Remarks

Note that changing this property does not change the sorting of the data, it is only used to display a sort direction indicator. To sort data according to a column use Avalonia.Controls.TreeDataGridSource.SortBy(Avalonia.Controls.TreeDataGridColumn,System.ComponentModel.ListSortDirection).

Tag Property

Gets or sets a user-defined object attached to the column.

public object Tag { get; set; }

VerticalContentAlignment Property

Gets or sets the vertical alignment of the content within a cell in the column.

public Avalonia.Layout.VerticalAlignment VerticalContentAlignment { get; set; }

Width Property

Gets or sets the width of the column.

public Avalonia.Controls.GridLength Width { get; set; }

Fields

Name	Description
ActualWidthProperty	Defines the Avalonia.Controls.TreeDataGridColumn.ActualWidth property.
AllowTriStateSortingProperty	Defines the Avalonia.Controls.TreeDataGridColumn.AllowTriStateSorting property.
BeginEditGesturesProperty	Defines the Avalonia.Controls.TreeDataGridColumn.BeginEditGestures property.
CanUserResizeProperty	Defines the Avalonia.Controls.TreeDataGridColumn.CanUserResize property.
CanUserSortProperty	Defines the Avalonia.Controls.TreeDataGridColumn.CanUserSort property.
CompareAscendingProperty	Defines the Avalonia.Controls.TreeDataGridColumn.CompareAscending property.
CompareDescendingProperty	Defines the Avalonia.Controls.TreeDataGridColumn.CompareDescending property.
HeaderProperty	Defines the Avalonia.Controls.TreeDataGridColumn.Header property.
HorizontalContentAlignmentProperty	Defines the Avalonia.Controls.TreeDataGridColumn.HorizontalContentAlignment property.
IsVisibleProperty	Defines the Avalonia.Controls.TreeDataGridColumn.IsVisible property.
MaxWidthProperty	Defines the Avalonia.Controls.TreeDataGridColumn.MaxWidth property.
MinWidthProperty	Defines the Avalonia.Controls.TreeDataGridColumn.MinWidth property.
SortDirectionProperty	Defines the Avalonia.Controls.TreeDataGridColumn.SortDirection property.
TagProperty	Defines the Avalonia.Controls.TreeDataGridColumn.Tag property.
VerticalContentAlignmentProperty	Defines the Avalonia.Controls.TreeDataGridColumn.VerticalContentAlignment property.
WidthProperty	Defines the Avalonia.Controls.TreeDataGridColumn.Width property.

ActualWidthProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.ActualWidth property.

public Avalonia.DirectProperty<Avalonia.Controls.TreeDataGridColumn, double> ActualWidthProperty

AllowTriStateSortingProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.AllowTriStateSorting property.

public Avalonia.StyledProperty<Nullable<bool>> AllowTriStateSortingProperty

BeginEditGesturesProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.BeginEditGestures property.

public Avalonia.StyledProperty<Avalonia.Controls.BeginEditGestures> BeginEditGesturesProperty

CanUserResizeProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.CanUserResize property.

public Avalonia.StyledProperty<Nullable<bool>> CanUserResizeProperty

CanUserSortProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.CanUserSort property.

public Avalonia.StyledProperty<Nullable<bool>> CanUserSortProperty

CompareAscendingProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.CompareAscending property.

public Avalonia.StyledProperty<Comparison<object>> CompareAscendingProperty

CompareDescendingProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.CompareDescending property.

public Avalonia.StyledProperty<Comparison<object>> CompareDescendingProperty

HeaderProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.Header property.

public Avalonia.StyledProperty<object> HeaderProperty

HorizontalContentAlignmentProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.HorizontalContentAlignment property.

public Avalonia.StyledProperty<Avalonia.Layout.HorizontalAlignment> HorizontalContentAlignmentProperty

IsVisibleProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.IsVisible property.

public Avalonia.StyledProperty<bool> IsVisibleProperty

MaxWidthProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.MaxWidth property.

public Avalonia.StyledProperty<Nullable<Avalonia.Controls.GridLength>> MaxWidthProperty

MinWidthProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.MinWidth property.

public Avalonia.StyledProperty<Avalonia.Controls.GridLength> MinWidthProperty

SortDirectionProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.SortDirection property.

public Avalonia.StyledProperty<Nullable<System.ComponentModel.ListSortDirection>> SortDirectionProperty

TagProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.Tag property.

public Avalonia.StyledProperty<object> TagProperty

VerticalContentAlignmentProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.VerticalContentAlignment property.

public Avalonia.StyledProperty<Avalonia.Layout.VerticalAlignment> VerticalContentAlignmentProperty

WidthProperty Field

Defines the Avalonia.Controls.TreeDataGridColumn.Width property.

public Avalonia.StyledProperty<Avalonia.Controls.GridLength> WidthProperty

Events

Name	Description
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.