Back to Devexpress

DxTreeView Members

blazor-devexpress-dot-blazor-dot-dxtreeview-dot-underscore-members.md

latest11.2 KB
Original Source

DxTreeView Members

A navigation control that displays items as a tree.

Constructors

NameDescription
DxTreeView()Initializes a new instance of the DxTreeView class.

Properties

NameDescription
AllowSelectNodesSpecifies whether or not nodes can be selected.
AnimationTypeSpecifies the animation type.
AttributesSpecifies a collection of standard HTML attributes applied to the TreeView.
CheckAllTextSpecifies the label of the Check All box.
CheckAllVisibleSpecifies whether the Check All box is visible.
CheckModeSpecifies the check mode.
CheckNodeByClickSpecifies whether users can click nodes to check and uncheck them.
ChildrenExpressionObsolete. Specifies an expression that returns a node’s children.
CollapseButtonIconCssClassSpecify a CSS class for the collapse button’s icon.
CssClassAssigns a CSS class to the component. Inherited from DxComponent.
CustomFilterAllows you to implement custom filter logic.
DataSpecifies a data source.
DataMappingsSpecifies data mappings.
EnabledSpecifies whether the TreeView component is enabled.
ExpandButtonIconCssClassSpecify a CSS class for the expand button’s icon.
FilterMinLengthSpecifies the minimum number of characters a user must type in the search box to apply the filter.
FilterModeSpecifies how the component displays filtered nodes.
FilterNullTextSpecifies the filter panel’s prompt text.
FilterStringSpecifies the filter criteria used to filter the component’s nodes.
HasChildrenExpressionObsolete. A lambda expression that specifies whether the data item has child items.
IconCssClassExpressionObsolete. Specifies an expression that returns the name of a CSS class applied to a node’s icon.
IdSpecifies the component’s unique identifier. Inherited from DxComponent.
LoadChildNodesOnDemandSpecifies whether TreeView child nodes are loaded on demand.
NameExpressionObsolete. Specifies an expression that returns a node’s name.
NavigateUrlExpressionObsolete. Specifies an expression that returns a node’s target URL.
NodeExpandCollapseActionSpecifies user actions that expand or collapse a node.
NodesProvides access to the component node collection.
NodeTemplateSpecifies the common template used to display all nodes.
NodeTextTemplateSpecifies the common template for the text in the TreeView node labels.
ShowExpandButtonsSpecifies whether expand buttons are visible.
ShowFilterPanelSpecifies whether the TreeView displays the filter panel.
SizeModeSpecifies the size of the component’s inner elements. Affects the component’s size as well.
TargetSpecifies the target attribute’s value for all nodes.
TextExpressionObsolete. Specifies an expression that returns a node’s text.
TextWrapEnabledSpecifies whether word wrap is enabled.
UrlMatchModeSpecifies whether the TreeView can automatically expand to the node and select it if the DxTreeViewNode.NavigateUrl property value points to the active web page.
VisibleSpecifies the TreeView component’s visibility.

Methods

NameDescription
CheckAll()Checks all nodes in the TreeView.
ClearCheck()Unchecks all nodes.
ClearSelection()Clears node selection.
CollapseAll()Collapses all nodes in the DxTreeView.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
ExpandAll()Expands all nodes in the DxTreeView.
ExpandToNode(Func<ITreeViewNodeInfo, Boolean>)Expands the nodes down to the specified node.
GetCheckedNodeInfo()Returns a collection of currently checked nodes.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetNodeExpanded(Func<ITreeViewNodeInfo, Boolean>)Returns whether the specified node is expanded.
GetNodeInfo(Func<ITreeViewNodeInfo, Boolean>)Returns information about the specified node.
GetNodesInfo(Func<ITreeViewNodeInfo, Boolean>)Returns information about the specified nodes.
GetSelectedNodeInfo()Returns information about the selected node.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SelectNode(Func<ITreeViewNodeInfo, Boolean>)Selects the specified node.
SetNodeChecked(Func<ITreeViewNodeInfo, Boolean>, Boolean)Checks or unchecks the specified node.
SetNodeExpanded(Func<ITreeViewNodeInfo, Boolean>, Boolean)Expands or collapses the specified node.
SetNodesChecked(Func<ITreeViewNodeInfo, Boolean>, Boolean)Checks or unchecks the specified nodes.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
AfterCollapseFires after a node has been collapsed.
AfterExpandFires after a node has been expanded.
BeforeCollapseFires when a node is about to be collapsed and allows you to cancel the action.
BeforeExpandFires when a node is about to be expanded and allows you to cancel the action.
CheckedChangedFires when a node’s checked state changes.
FilterStringChangedFires when a component’s filter string changes.
NodeClickFires when a user clicks a TreeView node.
SelectionChangedFires after node selection has been changed.

See Also

DxTreeView Class

DevExpress.Blazor Namespace