Skip to content

TreeListControlBase class

Provides a base class for data controls that display a collection of items arranged in a hierarchy of nodes.

Namespace: Eremex.AvaloniaUI.Controls.TreeList
Assembly: Eremex.Avalonia.Controls.dll
NuGet Package: Eremex.Avalonia.Controls

Declaration

public abstract class TreeListControlBase : DataControlBase

Properties

name description
AllowDragDrop { get; set; } Gets or sets whether node drag-and-drop is enabled.
AllowDragDropSortedNodes { get; set; } Gets or sets whether nodes can be dragged when the data is sorted.
AllowDropInsideNode { get; set; } Gets or sets whether a node can accept dragged nodes inside it.
AllowDynamicDataLoading { get; set; } Gets or sets whether child nodes are loaded on demand when their parent is expanded.
AllowIndeterminateCheckState { get; set; } Gets or sets whether parent check boxes can be in the indeterminate state.
AllowRecursiveNodeChecking { get; set; } Gets or sets whether checking a node checks all its descendants.
AllowScrollingOnDrag { get; set; } Gets or sets whether the view scrolls automatically when a dragged element approaches its edge.
AutoExpandAllNodes { get; set; } Gets or sets whether all nodes are expanded automatically.
AutoExpandDelayOnDrag { get; set; } Gets or sets the delay before a node is expanded automatically on drag-over.
AutoExpandOnDrag { get; set; } Gets or sets whether a collapsed node is expanded automatically when a dragged element hovers over it.
AutoScrollOnSorting { get; set; } Gets or sets whether the view scrolls to the focused node after sorting.
CheckBoxFieldName { get; set; } Gets or sets the field that stores node check states.
ChildrenFieldName { get; set; } Gets or sets the field that contains a node's child items.
ChildrenSelector { get; set; } Gets or sets the object that supplies child items for nodes.
Commands { get; } Gets the tree's commands.
ExpandNodesOnFiltering { get; set; } Gets or sets whether nodes are expanded automatically when a filter is applied.
ExpandStateFieldName { get; set; } Gets or sets the field that stores the expanded state of nodes.
FilterMode { get; set; } Gets or sets which nodes are displayed when a filter is applied.
FocusedNode { get; set; } Gets or sets the focused node.
HasChildrenFieldName { get; set; } Gets or sets the field that indicates whether a node has children.
KeyFieldName { get; set; } Gets or sets the field that uniquely identifies nodes in self-referential data.
NodeImageFieldName { get; set; } Gets or sets the field that contains node images.
NodeImageSelector { get; set; } Gets or sets the object that provides images for nodes.
Nodes { get; } Gets the root collection of nodes.
ParentFieldName { get; set; } Gets or sets the field that references the parent node key in self-referential data.
RestoreStateKeyFieldName { get; set; } Gets or sets the field whose values identify nodes when restoring the saved control state.
RootValue { get; set; } Gets or sets the parent key value that identifies root nodes in self-referential data.
RowCellMenu { get; set; } Gets or sets the context menu invoked for data cells.
ShowExpandButtons { get; set; } Gets or sets whether expand buttons are displayed.
ShowNodeCheckBoxes { get; set; } Gets or sets whether node check boxes are displayed.
ShowNodeImages { get; set; } Gets or sets whether node images are displayed.
ShowRootIndent { get; set; } Gets or sets whether the root level indent is displayed.
UsePlatformRowDragDrop { get; set; } Gets or sets whether the platform drag-and-drop is used when dragging nodes.
VisibleNodeCount { get; } Gets the number of currently visible nodes.

Methods

name description
CheckAllNodes() Checks all visible nodes.
CollapseAllNodes() Collapses all nodes.
override CommitEditing()
ExpandAllNodes() Expands all nodes.
FindNode(…) Returns the first node that satisfies the specified condition.
GetAllCheckedNodes() Returns the list of all checked nodes.
GetNodeByVisibleIndex(…) Returns the node displayed at the specified visible index.
GetSelectedNodes() Returns the list of selected nodes.
GetVisibleIndexByNode(…) Returns the visible index of the specified node.
IsNodeSelected(…) Gets whether the specified node is selected.
MoveFirstNode() Moves focus to the first node.
MoveLastNode() Moves focus to the last node.
MoveNextNode() Moves focus to the next node.
MovePrevNode(…) Moves focus to the previous node.
RefreshData() Refreshes the control's data.
RefreshNode(…) Refreshes the specified node's displayed data.
RefreshNodeChildren(…) Refreshes the specified node's child nodes.
ScrollIntoView(…) Scrolls the view to make the specified node visible.
SelectNode(…) Selects the specified node.
SelectRange(…) Selects all nodes between the specified start and end nodes.
UncheckAllNodes() Unchecks all visible nodes.
UnselectNode(…) Removes the selection from the specified node.

Events

name description
event CompleteDragDrop Occurs after the drag-and-drop operation is completed.
event CustomNodeFilter Occurs when custom filtering is applied to nodes.
event DragOver Occurs when a dragged element is over the control.
event Drop Occurs when a dragged element is dropped onto the control.
event FocusedColumnChanged Occurs when the focused column is changed.
event FocusedNodeChanged Occurs when the focused node is changed.
event NodeChanged Occurs when a node's data or state is changed.
event NodeCheckStateChanged Occurs when a node's check state is changed.
event NodeClick Occurs when a node is clicked.
event NodeCollapsed Occurs after a node is collapsed.
event NodeCollapsing Occurs before a node is collapsed.
event NodeExpanded Occurs after a node is expanded.
event NodeExpanding Occurs before a node is expanded.
event SelectionChanged Occurs when the node selection is changed.
event StartDrag Occurs when node dragging is started.

See Also

Used in articles