Skip to main content

DxTreeView Members

A navigation control that displays items as a tree.

Constructors

Name Description
DxTreeView() Initializes a new instance of the DxTreeView class.

Properties

Name Description
AllowSelectNodes Specifies whether or not nodes can be selected.
AnimationType Specifies the animation type.
CheckAllText Specifies the label of the Check All box.
CheckAllVisible Specifies whether the Check All box is visible.
CheckMode Specifies the check mode.
CheckNodeByClick Specifies whether users can click nodes to check and uncheck them.
ChildrenExpression Obsolete. Specifies an expression that returns a node’s children.
CollapseButtonIconCssClass Specify a CSS class for the collapse button’s icon.
CssClass Specifies the name of the component’s CSS class. Inherited from DxComponentBase.
CustomFilter Allows you to implement custom filter logic.
Data Specifies a data source.
DataMappings Specifies data mappings.
Enabled Specifies whether the navigation component is enabled. Inherited from DxNavigationControlComponent<JSProxyType, TModel>.
ExpandButtonIconCssClass Specify a CSS class for the expand button’s icon.
FilterMinLength Specifies the minimum number of characters a user must type in the search box to apply the filter.
FilterMode Specifies how the component displays filtered nodes.
FilterNullText Specifies the filter panel’s prompt text.
FilterString Specifies the filter criteria used to filter the component’s nodes.
HasChildrenExpression Obsolete. A lambda expression that specifies whether the data item has child items.
IconCssClassExpression Obsolete. Specifies an expression that returns the name of a CSS class applied to a node’s icon.
Id Specifies the component’s unique identifier. Inherited from DxComponentBase.
LoadChildNodesOnDemand Specifies whether TreeView child nodes are loaded on demand.
NameExpression Obsolete. Specifies an expression that returns a node’s name.
NavigateUrlExpression Obsolete. Specifies an expression that returns a node’s target URL.
NodeExpandCollapseAction Specifies user actions that expand or collapse a node.
Nodes Provides access to the component node collection.
NodeTemplate Specifies the common template used to display all nodes.
NodeTextTemplate Specifies the common template for the text in the TreeView node labels.
ShowExpandButtons Specifies whether expand buttons are visible.
ShowFilterPanel Specifies whether the TreeView displays the filter panel.
SizeMode Specifies the size of the component’s inner elements. Affects the component’s size as well.
Target Specifies the target attribute’s value for all nodes.
TextExpression Obsolete. Specifies an expression that returns a node’s text.
TextWrapEnabled Specifies whether word wrap is enabled.
UrlMatchMode Specifies whether the TreeView can automatically expand to the node and select it if the DxTreeViewNode.NavigateUrl property value points to the active web page.
Visible Specifies the navigation or layout component’s visibility. Inherited from DxNavigationControlComponent<JSProxyType, TModel>.

Methods

Name Description
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) static Determines 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() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines 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

Name Description
AfterCollapse Fires after a node has been collapsed.
AfterExpand Fires after a node has been expanded.
BeforeCollapse Fires when a node is about to be collapsed and allows you to cancel the action.
BeforeExpand Fires when a node is about to be expanded and allows you to cancel the action.
CheckedChanged Fires when a node’s checked state changes.
FilterStringChanged Fires when a component’s filter string changes.
NodeClick Fires when a user clicks a TreeView node.
SelectionChanged Fires after node selection has been changed.
See Also