Class

RadTreeView

Initializes a new instance of the RadTreeView class with default settings. Sets up event handlers and prepares the tree view for operation.

Declaration

public RadTreeView()

Gets the active editor currently being used for editing a tree node. Returns null if no node is currently being edited.

Declaration

public IInputEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether adding new tree nodes is allowed. When enabled, users can create new nodes through the user interface.

Declaration

public virtual bool AllowAdd { get; set; }

Property Value

Gets or sets a value indicating whether tree nodes can have different heights. When enabled, individual nodes can be sized independently based on their content.

Declaration

[Browsable(true)]
public virtual bool AllowArbitraryItemHeight { get; set; }

Property Value

Gets or sets a value indicating whether the default context menu is enabled for the tree view. When enabled, a built-in context menu with common operations is available.

Declaration

public bool AllowDefaultContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether drag and drop operations with tree view nodes are enabled. When enabled, users can drag nodes to reorder or move them within the tree structure.

Declaration

public virtual bool AllowDragDrop { get; set; }

Property Value

Gets or sets a value indicating whether node text editing is allowed. When enabled, users can edit node text by clicking on selected nodes or pressing F2.

Declaration

public virtual bool AllowEdit { get; set; }

Property Value

Gets or sets a value indicating whether animation of expand/collapse buttons is enabled. When enabled, the plus/minus buttons will be animated during expand/collapse operations.

Declaration

public bool AllowPlusMinusAnimation { get; set; }

Property Value

Gets or sets a value indicating whether removing tree nodes is allowed. When enabled, users can delete nodes through the user interface.

Declaration

public virtual bool AllowRemove { get; set; }

Property Value

Gets or sets a value indicating whether child nodes should be automatically checked when the tree view is in tri-state mode. When enabled, checking a parent node will automatically check all its child nodes.

Declaration

public virtual bool AutoCheckChildNodes { get; set; }

Property Value

Gets or sets a value indicating whether the control automatically provides scrollbars when content exceeds the visible area. This property controls the automatic display of scrollbars in the tree view when needed.

Declaration

[Browsable(false)]
public override bool AutoScroll { get; set; }

Property Value

Overrides ScrollableControl.AutoScroll

Gets or sets a value indicating whether checkboxes are displayed beside the tree nodes. When enabled, users can check/uncheck nodes independently of selection.

Declaration

public virtual bool CheckBoxes { get; set; }

Property Value

Gets or sets the property in the data source that determines the checked state of tree node checkboxes. This property is used when CheckBoxes is enabled and the tree view is data-bound.

Declaration

public virtual string CheckedMember { get; set; }

Property Value

Gets the collection of tree nodes that are currently checked. This collection is populated when CheckBoxes is enabled.

Declaration

[Browsable(false)]
public virtual CheckedTreeNodeCollection CheckedNodes { get; }

Property Value

Gets or sets the property in the data source that contains child node data for hierarchical binding. This property is used for self-referencing data sources to establish parent-child relationships.

Declaration

public virtual string ChildMember { get; set; }

Property Value

Gets or sets the ContextMenuStrip associated with this control.

Declaration

[Browsable(false)]
public override ContextMenuStrip ContextMenuStrip { get; set; }

Property Value

Overrides Control.ContextMenuStrip

Gets or sets the name of the data member in the data source for which the RadTreeView is displaying data. This property specifies which table or list within the data source to bind to.

Declaration

[Browsable(true)]
public virtual string DataMember { get; set; }

Property Value

Gets or sets the data source that provides data for the RadTreeView. This can be any object that implements IList or IListSource.

Declaration

public virtual object DataSource { get; set; }

Property Value

Implements IFilterable.DataSource

Gets the default size for the tree view control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets the property to display for each tree node when the tree view is data-bound. This property specifies which field from the data source should be used for node text.

Declaration

public virtual string DisplayMember { get; set; }

Property Value

Gets or sets the color of the drop hint displayed during drag and drop operations. The drop hint provides visual feedback to assist users in understanding where items can be dropped.

Declaration

public Color DropHintColor { get; set; }

Property Value

Gets or sets a value indicating whether deferred scrolling is enabled for improved performance. When enabled, scrolling updates are deferred until the scrolling operation completes.

Declaration

[Browsable(false)]
public bool EnableDeferredScrolling { get; set; }

Property Value

Gets or sets a value indicating whether kinetic scrolling is enabled for touch-based interactions. When enabled, scrolling continues with momentum after the user stops touching, providing a natural scrolling experience.

Declaration

[Browsable(true)]
public bool EnableKineticScrolling { get; set; }

Property Value

Gets or sets a value indicating whether the UI Automation functionality is enabled or disabled for this control.

Declaration

public override bool EnableUIAutomation { get; set; }

Property Value

Overrides RadControl.EnableUIAutomation

Implements ISupportRootUIAutomation.EnableUIAutomation

Gets or sets the type of animation used when expanding or collapsing tree nodes. This property controls the visual effect applied during node expand/collapse operations.

Declaration

public ExpandAnimation ExpandAnimation { get; set; }

Property Value

Gets or sets the expand mode that controls how nodes can be expanded. This property determines whether single or multiple nodes can be expanded simultaneously.

Declaration

[Browsable(false)]
public ExpandMode ExpandMode { get; set; }

Property Value

Gets or sets the filter applied to tree nodes. This property allows filtering of tree nodes based on custom criteria.

Declaration

[Browsable(false)]
public virtual object Filter { get; set; }

Property Value

Gets the collection of filter descriptors applied to the tree view. These descriptors define the filtering criteria for tree nodes.

Declaration

[Browsable(false)]
public virtual FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Implements IFilterable.FilterDescriptors

Gets or sets the string comparer used for keyboard navigation functionality. This comparer determines how text matching is performed during keyboard search.

Declaration

[Browsable(false)]
public virtual IFindStringComparer FindStringComparer { get; set; }

Property Value

Gets or sets a value indicating whether the selection highlight spans the full width of the tree view. When enabled, the selected node highlight extends across the entire width of the control.

Declaration

public virtual bool FullRowSelect { get; set; }

Property Value

Gets the horizontal scroll bar element of the tree view control. This scroll bar appears when the tree content extends beyond the control's width.

Declaration

[Browsable(false)]
public RadScrollBarElement HScrollBar { get; }

Property Value

Gets or sets a value indicating whether the selection highlight is hidden when the control loses focus. When enabled, selected nodes remain visually highlighted even when the tree view is not focused.

Declaration

public virtual bool HideSelection { get; set; }

Property Value

Gets or sets a value indicating whether hot tracking is enabled for tree nodes. When enabled, nodes are highlighted when the mouse pointer hovers over them.

Declaration

public virtual bool HotTracking { get; set; }

Property Value

Gets or sets the default image index for tree nodes in the associated ImageList. This value is used for nodes that don't have a specific image index assigned.

Declaration

[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public virtual int ImageIndex { get; set; }

Property Value

Gets or sets the default image key for tree nodes in the associated ImageList. This value is used for nodes that don't have a specific image key assigned.

Declaration

[RelatedImageList("ImageList")]
[TypeConverter(typeof(ImageKeyConverter))]
public virtual string ImageKey { get; set; }

Property Value

Gets a value indicating whether there is an active editor currently open for editing a tree node. Returns true if a node is currently being edited, false otherwise.

Declaration

[Browsable(true)]
public bool IsEditing { get; }

Property Value

Gets or sets the height of tree view items in pixels. This property controls the vertical spacing of tree nodes.

Declaration

[Browsable(false)]
public virtual int ItemHeight { get; set; }

Property Value

Gets or sets a value indicating whether keyboard search navigation is enabled. When enabled, users can navigate to nodes by typing the first characters of node text.

Declaration

[Browsable(true)]
public virtual bool KeyboardSearchEnabled { get; set; }

Property Value

Gets or sets the time interval in milliseconds before keyboard search is reset. This determines how long to wait between keystrokes before starting a new search.

Declaration

[Browsable(true)]
public virtual int KeyboardSearchResetInterval { get; set; }

Property Value

Gets or sets a value indicating whether the tree view loads child node collections in the NodesNeeded event only when parent nodes are expanded. This lazy loading approach improves performance by deferring node loading until actually needed.

Declaration

[Browsable(false)]
public bool LazyMode { get; set; }

Property Value

Gets or sets the color of the lines connecting parent and child nodes in the tree view. This property is only effective when ShowLines is enabled.

Declaration

public virtual Color LineColor { get; set; }

Property Value

Gets or sets the style of lines connecting parent and child nodes in the tree view. This property controls the visual appearance of the connecting lines when ShowLines is enabled.

Declaration

public virtual TreeLineStyle LineStyle { get; set; }

Property Value

Gets or sets the width in pixels of the lines connecting parent and child nodes. This property controls the thickness of the connecting lines when ShowLines is enabled.

Declaration

public virtual float LineWidth { get; set; }

Property Value

Gets or sets a value indicating whether the user is allowed to select multiple tree nodes at one time. When enabled, users can hold Ctrl or Shift keys to select multiple nodes.

Declaration

public virtual bool MultiSelect { get; set; }

Property Value

Gets the collection of tree nodes that are assigned to the tree view control. This collection contains all root-level nodes and provides access to the entire tree structure.

Declaration

[Browsable(true)]
public virtual RadTreeNodeCollection Nodes { get; }

Property Value

Gets or sets the property in the data source that identifies the parent node for hierarchical binding. This property is used for self-referencing data sources to establish parent-child relationships.

Declaration

public virtual string ParentMember { get; set; }

Property Value

Gets or sets the character used as a separator in the node path. This separator is used when constructing or parsing hierarchical node paths.

Declaration

public virtual string PathSeparator { get; set; }

Property Value

Gets or sets the opacity animation step for expand/collapse animation. This controls the granularity of the opacity change during node expand/collapse animations.

Declaration

[Browsable(false)]
public double PlusMinusAnimationStep { get; set; }

Property Value

Gets or sets the RadContextMenu associated with this tree view control. This context menu is displayed when users right-click on the tree view.

Declaration

public virtual RadContextMenu RadContextMenu { get; set; }

Property Value

Gets the collection of relation bindings that define how hierarchical data relationships are established. This collection contains data binding settings for related data in master-detail scenarios.

Declaration

[Browsable(true)]
public RelationBindingCollection RelationBindings { get; }

Property Value

Gets or sets the currently selected tree node. Returns null if no node is selected.

Declaration

[Browsable(false)]
public virtual RadTreeNode SelectedNode { get; set; }

Property Value

Gets the collection of currently selected tree nodes. This collection contains all selected nodes when MultiSelect is enabled.

Declaration

[Browsable(false)]
public virtual SelectedTreeNodeCollection SelectedNodes { get; }

Property Value

Gets or sets a value indicating whether drag hints are displayed when dragging items. When enabled, visual feedback shows the item being dragged during drag and drop operations.

Declaration

public bool ShowDragHint { get; set; }

Property Value

Gets or sets a value indicating whether drop hints are displayed during drag and drop operations. When enabled, visual indicators show where items can be dropped in the tree hierarchy.

Declaration

public bool ShowDropHint { get; set; }

Property Value

Gets or sets a value indicating whether expand/collapse buttons are shown next to nodes with children. When enabled, plus/minus buttons allow users to expand or collapse parent nodes.

Declaration

public bool ShowExpandCollapse { get; set; }

Property Value

Gets or sets a value indicating whether lines connecting parent and child nodes are displayed. When enabled, visual lines show the hierarchical relationship between nodes.

Declaration

public virtual bool ShowLines { get; set; }

Property Value

Gets or sets a value indicating whether tooltips are displayed for tree nodes. When enabled, node tooltips will be shown when hovering over nodes with the mouse.

Declaration

public bool ShowNodeToolTips { get; set; }

Property Value

Gets or sets a value indicating whether lines are displayed between root-level nodes. When enabled, connecting lines are shown between top-level nodes in the tree view.

Declaration

public bool ShowRootLines { get; set; }

Property Value

Gets the collection of sort descriptors applied to the tree view. These descriptors define the sorting criteria for tree nodes.

Declaration

[Browsable(false)]
public SortDescriptorCollection SortDescriptors { get; }

Property Value

Gets or sets the sort order of tree nodes. This property controls how nodes are sorted within each level of the tree hierarchy.

Declaration

[Browsable(true)]
public SortOrder SortOrder { get; set; }

Property Value

Gets or sets the vertical spacing in pixels between tree nodes. This property controls the gap between adjacent nodes in the tree view.

Declaration

public int SpacingBetweenNodes { get; set; }

Property Value

Gets or sets the default toggle mode for expanding and collapsing tree nodes. This property determines how users can expand or collapse nodes (single click, double click, etc.).

Declaration

public virtual ToggleMode ToggleMode { get; set; }

Property Value

Gets or sets a TypeConverter used to convert checkbox toggle states to the underlying data type. This converter is used when binding checkbox states to data source properties.

Declaration

public virtual TypeConverter ToggleStateConverter { get; set; }

Property Value

Gets the topmost visible tree node in the tree view control. This property returns the first node that is currently visible in the control's view area.

Declaration

[Browsable(false)]
public RadTreeNode TopNode { get; }

Property Value

Gets or sets the indentation distance in pixels for each level of tree nodes. This controls the horizontal spacing between parent and child nodes.

Declaration

public int TreeIndent { get; set; }

Property Value

Gets the underlying tree view element that provides the core functionality for the control. This element contains the main logic and rendering capabilities of the tree view.

Declaration

[Browsable(false)]
public virtual RadTreeViewElement TreeViewElement { get; }

Property Value

Gets or sets the XML representation of the tree view structure. This property allows saving and loading the entire tree structure as XML data.

Declaration

public string TreeViewXml { get; set; }

Property Value

Gets or sets a value indicating whether tri-state mode is enabled for node checkboxes. When enabled, checkboxes can have three states: checked, unchecked, and indeterminate.

Declaration

public virtual bool TriStateMode { get; set; }

Property Value

Gets the vertical scroll bar element of the tree view control. This scroll bar appears when the tree content extends beyond the control's height.

Declaration

[Browsable(false)]
public RadScrollBarElement VScrollBar { get; }

Property Value

Gets or sets the property in the data source that provides the value for each tree node. This property specifies which field from the data source should be used for node values.

Declaration

public virtual string ValueMember { get; set; }

Property Value

Gets the number of tree nodes that can be fully visible in the tree view control. This count is based on the current size of the control and the height of the nodes.

Declaration

[Browsable(false)]
public int VisibleCount { get; }

Property Value

Creates a new tree node and adds it at the location specified by the hierarchical path. The path is parsed using the PathSeparator to determine the node hierarchy.

Declaration

public virtual RadTreeNode AddNodeByPath(string path)

Parameters

Returns

Creates a new tree node and adds it at the location specified by the hierarchical path using a custom path separator. The path is parsed using the specified separator to determine the node hierarchy.

Declaration

public virtual RadTreeNode AddNodeByPath(string path, string pathSeparator)

Parameters

Returns

Begins edit mode for the currently selected tree node.

Declaration

public bool BeginEdit()

Returns

Suspends layout during initialization.

Declaration

public override void BeginInit()

Overrides RadControl.BeginInit()

Disables visual updates to the tree view to improve performance during batch operations. Must be paired with a call to EndUpdate().

Declaration

public void BeginUpdate()

Scrolls the tree view to ensure the specified node is visible within the control's display area.

Declaration

public void BringIntoView(RadTreeNode node)

Parameters

Closes the currently active editor and discards any changes made during editing.

Declaration

public void CancelEdit()

Clears the current node selection, deselecting all currently selected nodes.

Declaration

public virtual void ClearSelection()

Collapses all tree nodes in the tree view, hiding all child nodes.

Declaration

public void CollapseAll()

Collapses all nodes in the specified collection, hiding their child nodes.

Declaration

public void CollapseAll(RadTreeNodeCollection nodes)

Parameters

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the child elements that make up the tree view control structure. This method instantiates the main RadTreeViewElement and adds it to the parent container.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates and returns a new instance of the tree view element that provides the core functionality. This method can be overridden in derived classes to provide custom tree view element implementations.

Declaration

protected virtual RadTreeViewElement CreateTreeViewElement()

Returns

Defers refresh operations for the tree view, returning a disposable object that triggers refresh when disposed. This is useful for batching multiple operations while maintaining automatic cleanup.

Declaration

public virtual IDisposable DeferRefresh()

Returns

Releases the unmanaged resources used by the RadTreeView and optionally releases the managed resources. This method cleans up event handlers and disposes of the context menu if it's the default implementation.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Commits any changes and ends the edit operation on the currently edited node.

Declaration

public bool EndEdit()

Returns

Resumes layout.

Declaration

public override void EndInit()

Overrides RadControl.EndInit()

Re-enables visual updates to the tree view after a call to BeginUpdate(). This will refresh the tree view display with any changes made during the update period.

Declaration

public void EndUpdate()

Executes the specified command on the tree view with optional settings.

Declaration

public object Execute(ICommand command, params object[] settings)

Parameters

Returns

Executes the specified command on the tree view with control over subtree inclusion.

Declaration

public object Execute(bool includeSubTrees, ICommand command, params object[] settings)

Parameters

Returns

Executes a command over an entire subtree starting with the specified node.

Declaration

public static List<object> ExecuteBatchCommand(RadTreeNode node, int level, ICommand command, params object[] settings)

Parameters

Returns

Executes a command over an entire subtree starting with the specified node collection. This static method allows batch operations across multiple tree branches.

Declaration

public static List<object> ExecuteBatchCommand(RadTreeNodeCollection nodes, int level, ICommand command, params object[] settings)

Parameters

Returns

Executes a command over an entire subtree starting with the specified node. This static method returns the first result from the batch execution.

Declaration

public static object ExecuteScalarCommand(RadTreeNode node, int level, ICommand command, params object[] settings)

Parameters

Returns

Expands all tree nodes in the tree view, revealing all child nodes.

Declaration

public void ExpandAll()

Expands all nodes in the specified collection, revealing their child nodes.

Declaration

public virtual void ExpandAll(RadTreeNodeCollection nodes)

Parameters

Searches for the first tree node that matches the specified predicate function.

Declaration

public RadTreeNode Find(Predicate<RadTreeNode> match)

Parameters

Returns

Searches for the first tree node whose text contains the specified string.

Declaration

public virtual RadTreeNode Find(string text)

Parameters

Returns

Searches for the first tree node that matches the specified search function with a parameter.

Declaration

public RadTreeNode Find<T>(FindAction<T> match, T arg)

Parameters

Returns

Searches for all tree nodes that match the specified predicate function.

Declaration

public RadTreeNode[] FindNodes(Predicate<RadTreeNode> match)

Parameters

Returns

Searches for all tree nodes whose text contains the specified string.

Declaration

public virtual RadTreeNode[] FindNodes(string text)

Parameters

Returns

Searches for all tree nodes that match the specified search function with a parameter.

Declaration

public RadTreeNode[] FindNodes<T>(FindAction<T> match, T arg)

Parameters

Returns

Executes the specified action for every tree node in the tree view. The action is applied recursively to all nodes in the tree structure.

Declaration

public void ForEach(Action<RadTreeNode> action)

Parameters

Retrieves the tree node located at the specified point in client coordinates.

Declaration

public RadTreeNode GetNodeAt(Point pt)

Parameters

Returns

Retrieves the tree node located at the specified coordinates in client coordinates.

Declaration

public RadTreeNode GetNodeAt(int x, int y)

Parameters

Returns

Retrieves the first tree node with the specified name from the entire tree. Searches recursively through all nodes in the tree view.

Declaration

public RadTreeNode GetNodeByName(string name)

Parameters

Returns

Retrieves the first tree node with the specified name, searching from a specific root node. Searches recursively through the specified root node and its descendants.

Declaration

public RadTreeNode GetNodeByName(string name, RadTreeNode rootNode)

Parameters