Skip to main content

TreeDataGridHierarchicalExpanderColumn Class

Definition

Assembly:Avalonia.Controls.TreeDataGrid
Package:Avalonia.Controls.TreeDataGrid

A column in an Avalonia.Controls.HierarchicalTreeDataGridSource<T> whose cells show an expander to reveal nested data.

public class TreeDataGridHierarchicalExpanderColumn

Inheritance: object -> AvaloniaObject -> TreeDataGridColumn -> TreeDataGridHierarchicalExpanderColumn

Constructors

NameDescription
TreeDataGridHierarchicalExpanderColumnInitializes a new instance of the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn class for use in XAML.

TreeDataGridHierarchicalExpanderColumn Constructor

Initializes a new instance of the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn class for use in XAML.

public TreeDataGridHierarchicalExpanderColumn()

Methods

NameDescription
GetChildModelsGets the child models for the specified model.
GetModelIsExpandedNo summary available.
HasChildrenDetermines whether the specified model has children.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns 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.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValueInherited from AvaloniaObject.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks 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.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

GetChildModels Method

Gets the child models for the specified model.

public System.Collections.IEnumerable GetChildModels(object model)

Parameters

model object

The parent model.

Returns

System.Collections.IEnumerable

The child models, or null if there are no children.

GetModelIsExpanded Method

public bool GetModelIsExpanded(object model)

Parameters

model object

Returns

bool

HasChildren Method

Determines whether the specified model has children.

public bool HasChildren(object model)

Parameters

model object

The model.

Returns

bool

True if the model has children; otherwise false.

Properties

NameDescription
ChildrenBindingGets or sets the binding used to select the children collection from a model.
HasChildrenBindingGets or sets the binding used to determine whether a model has children.
InnerGets or sets the inner column that provides cell creation for this expander column.
IsExpandedBindingGets or sets the binding used to read the expanded state from a model.
ActualWidthGets the actual width of the column after measurement. Inherited from TreeDataGridColumn.
AllowTriStateSortingGets or sets whether the user can cycle through ascending, descending, and unsorted states when clicking the column header. Inherited from TreeDataGridColumn.
BeginEditGesturesGets or sets the gesture(s) that will cause a cell to enter edit mode. Inherited from TreeDataGridColumn.
CanUserResizeGets or sets a value indicating whether the user can resize the column by dragging. Inherited from TreeDataGridColumn.
CanUserSortGets or sets a value indicating whether the user can sort the column by clicking. Inherited from TreeDataGridColumn.
CellRendererGets the cell renderer for this column, or null if the column uses control-based cells. Inherited from TreeDataGridColumn.
CompareAscendingGets or sets a custom comparison for ascending sort order. Inherited from TreeDataGridColumn.
CompareDescendingGets or sets a custom comparison for descending sort order. Inherited from TreeDataGridColumn.
HeaderGets or sets the column header. Inherited from TreeDataGridColumn.
IsVisibleGets or sets a value indicating whether the column is visible. Inherited from TreeDataGridColumn.
MaxWidthGets or sets the maximum width for the column. Inherited from TreeDataGridColumn.
MinWidthGets or sets the minimum width for the column. Inherited from TreeDataGridColumn.
SortDirectionGets or sets the sort direction indicator that will be displayed on the column. Inherited from TreeDataGridColumn.
TagGets or sets a user-defined object attached to the column. Inherited from TreeDataGridColumn.
WidthGets or sets the width of the column. Inherited from TreeDataGridColumn.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
ItemInherited from AvaloniaObject.

ChildrenBinding Property

Gets or sets the binding used to select the children collection from a model.

public Avalonia.Data.BindingBase ChildrenBinding { get; set; }

Remarks

When set in XAML, this binding is used both to create the Avalonia.Controls.Models.TreeDataGrid.ExpanderCell and to derive the children selector via a Avalonia.Controls.Utils.BindingEvaluator.

HasChildrenBinding Property

Gets or sets the binding used to determine whether a model has children.

public Avalonia.Data.BindingBase HasChildrenBinding { get; set; }

Inner Property

Gets or sets the inner column that provides cell creation for this expander column.

public Avalonia.Controls.TreeDataGridColumn Inner { get; set; }

IsExpandedBinding Property

Gets or sets the binding used to read the expanded state from a model.

public Avalonia.Data.BindingBase IsExpandedBinding { get; set; }

Fields

NameDescription
ChildrenBindingPropertyDefines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.ChildrenBinding property.
HasChildrenBindingPropertyDefines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.HasChildrenBinding property.
IsExpandedBindingPropertyDefines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.IsExpandedBinding property.
ActualWidthPropertyDefines the Avalonia.Controls.TreeDataGridColumn.ActualWidth property. Inherited from TreeDataGridColumn.
AllowTriStateSortingPropertyDefines the Avalonia.Controls.TreeDataGridColumn.AllowTriStateSorting property. Inherited from TreeDataGridColumn.
BeginEditGesturesPropertyDefines the Avalonia.Controls.TreeDataGridColumn.BeginEditGestures property. Inherited from TreeDataGridColumn.
CanUserResizePropertyDefines the Avalonia.Controls.TreeDataGridColumn.CanUserResize property. Inherited from TreeDataGridColumn.
CanUserSortPropertyDefines the Avalonia.Controls.TreeDataGridColumn.CanUserSort property. Inherited from TreeDataGridColumn.
CompareAscendingPropertyDefines the Avalonia.Controls.TreeDataGridColumn.CompareAscending property. Inherited from TreeDataGridColumn.
CompareDescendingPropertyDefines the Avalonia.Controls.TreeDataGridColumn.CompareDescending property. Inherited from TreeDataGridColumn.
HeaderPropertyDefines the Avalonia.Controls.TreeDataGridColumn.Header property. Inherited from TreeDataGridColumn.
IsVisiblePropertyDefines the Avalonia.Controls.TreeDataGridColumn.IsVisible property. Inherited from TreeDataGridColumn.
MaxWidthPropertyDefines the Avalonia.Controls.TreeDataGridColumn.MaxWidth property. Inherited from TreeDataGridColumn.
MinWidthPropertyDefines the Avalonia.Controls.TreeDataGridColumn.MinWidth property. Inherited from TreeDataGridColumn.
SortDirectionPropertyDefines the Avalonia.Controls.TreeDataGridColumn.SortDirection property. Inherited from TreeDataGridColumn.
TagPropertyDefines the Avalonia.Controls.TreeDataGridColumn.Tag property. Inherited from TreeDataGridColumn.
WidthPropertyDefines the Avalonia.Controls.TreeDataGridColumn.Width property. Inherited from TreeDataGridColumn.

ChildrenBindingProperty Field

Defines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.ChildrenBinding property.

public Avalonia.StyledProperty<Avalonia.Data.BindingBase> ChildrenBindingProperty

HasChildrenBindingProperty Field

Defines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.HasChildrenBinding property.

public Avalonia.StyledProperty<Avalonia.Data.BindingBase> HasChildrenBindingProperty

IsExpandedBindingProperty Field

Defines the Avalonia.Controls.TreeDataGridHierarchicalExpanderColumn.IsExpandedBinding property.

public Avalonia.StyledProperty<Avalonia.Data.BindingBase> IsExpandedBindingProperty

Events

NameDescription
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.