Class RadTreeView

Represents a hierarchical tree view control that displays a collection of labeled items in a tree structure. Each item is represented by a RadTreeNode and can contain child nodes, images, and custom content. The control supports data binding, drag-and-drop operations, context menus, and various selection modes.

Inheritance
System.Object
RadControl
RadTreeView
FileBrowserTreeView
RadDataFilter
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadTreeView : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IFilterable, ISupportRootUIAutomation

Constructors

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()

Properties

ActiveEditor

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
IInputEditor

AllowAdd

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
System.Boolean

AllowArbitraryItemHeight

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
public virtual bool AllowArbitraryItemHeight { get; set; }
Property Value
System.Boolean

AllowDefaultContextMenu

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
System.Boolean

AllowDragDrop

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
System.Boolean

AllowEdit

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
System.Boolean

AllowPlusMinusAnimation

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
System.Boolean

AllowRemove

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
System.Boolean

AutoCheckChildNodes

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
System.Boolean

AutoScroll

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
public override bool AutoScroll { get; set; }
Property Value
System.Boolean

AutoSize

This property is not relevant for this class.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

This property is not relevant for this class.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CheckBoxes

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
System.Boolean

CheckedMember

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
System.String

CheckedNodes

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

Declaration
public virtual CheckedTreeNodeCollection CheckedNodes { get; }
Property Value
CheckedTreeNodeCollection

ChildMember

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
System.String

ContextMenuStrip

Gets or sets the System.Windows.Forms.ContextMenuStrip associated with this control.

Declaration
public override ContextMenuStrip ContextMenuStrip { get; set; }
Property Value
System.Windows.Forms.ContextMenuStrip

DataMember

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
public virtual string DataMember { get; set; }
Property Value
System.String

DataSource

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
System.Object

Implements

DefaultSize

Gets the default size for the tree view control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DisplayMember

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
System.String

DropHintColor

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
System.Drawing.Color

EnableDeferredScrolling

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
public bool EnableDeferredScrolling { get; set; }
Property Value
System.Boolean

EnableKineticScrolling

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
public bool EnableKineticScrolling { get; set; }
Property Value
System.Boolean

EnableUIAutomation

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
System.Boolean

Overrides
Implements

ExpandAnimation

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
ExpandAnimation

ExpandMode

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
public ExpandMode ExpandMode { get; set; }
Property Value
ExpandMode

Filter

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

Declaration
public virtual object Filter { get; set; }
Property Value
System.Object

FilterDescriptors

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

Declaration
public virtual FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

Implements

FindStringComparer

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

Declaration
public virtual IFindStringComparer FindStringComparer { get; set; }
Property Value
IFindStringComparer

ForeColor

This property is not relevant for this class.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

FullRowSelect

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
System.Boolean

HideSelection

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
System.Boolean

HotTracking

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
System.Boolean

HScrollBar

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
public RadScrollBarElement HScrollBar { get; }
Property Value
RadScrollBarElement

ImageIndex

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

Declaration
public virtual int ImageIndex { get; set; }
Property Value
System.Int32

ImageKey

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

Declaration
public virtual string ImageKey { get; set; }
Property Value
System.String

IsEditing

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
public bool IsEditing { get; }
Property Value
System.Boolean

ItemHeight

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

Declaration
public virtual int ItemHeight { get; set; }
Property Value
System.Int32

KeyboardSearchEnabled

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
public virtual bool KeyboardSearchEnabled { get; set; }
Property Value
System.Boolean

KeyboardSearchResetInterval

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
public virtual int KeyboardSearchResetInterval { get; set; }
Property Value
System.Int32

LazyMode

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
public bool LazyMode { get; set; }
Property Value
System.Boolean

LineColor

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
System.Drawing.Color

LineStyle

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
TreeLineStyle

LineWidth

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
System.Single

MultiSelect

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
System.Boolean

Nodes

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
public virtual RadTreeNodeCollection Nodes { get; }
Property Value
RadTreeNodeCollection

ParentMember

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
System.String

PathSeparator

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
System.String

PlusMinusAnimationStep

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
public double PlusMinusAnimationStep { get; set; }
Property Value
System.Double

RadContextMenu

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
RadContextMenu

RelationBindings

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
public RelationBindingCollection RelationBindings { get; }
Property Value
RelationBindingCollection

SelectedNode

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

Declaration
public virtual RadTreeNode SelectedNode { get; set; }
Property Value
RadTreeNode

SelectedNodes

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

Declaration
public virtual SelectedTreeNodeCollection SelectedNodes { get; }
Property Value
SelectedTreeNodeCollection

ShowDragHint

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
System.Boolean

ShowDropHint

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
System.Boolean

ShowExpandCollapse

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
System.Boolean

ShowLines

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
System.Boolean

ShowNodeToolTips

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
System.Boolean

ShowRootLines

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
System.Boolean

SortDescriptors

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

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

SortOrder

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

Declaration
public SortOrder SortOrder { get; set; }
Property Value
System.Windows.Forms.SortOrder

SpacingBetweenNodes

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
System.Int32

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ToggleMode

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
ToggleMode

ToggleStateConverter

Gets or sets a System.ComponentModel.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
System.ComponentModel.TypeConverter

TopNode

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
public RadTreeNode TopNode { get; }
Property Value
RadTreeNode

TreeIndent

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
System.Int32

TreeViewElement

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
public virtual RadTreeViewElement TreeViewElement { get; }
Property Value
RadTreeViewElement

TreeViewXml

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
System.String

TriStateMode

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
System.Boolean

ValueMember

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
System.String

VisibleCount

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
public int VisibleCount { get; }
Property Value
System.Int32

VScrollBar

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
public RadScrollBarElement VScrollBar { get; }
Property Value
RadScrollBarElement

Methods

AddNodeByPath(String)

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
System.String path

The hierarchical path where the node should be added.
Returns
RadTreeNode

The newly created RadTreeNode if the operation is successful.

AddNodeByPath(String, String)

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
System.String path

The hierarchical path where the node should be added.
System.String pathSeparator

The custom path separator to use for parsing the path.
Returns
RadTreeNode

The newly created RadTreeNode if the operation is successful.

BeginEdit()

Begins edit mode for the currently selected tree node.

Declaration
public bool BeginEdit()
Returns
System.Boolean

True if edit mode was successfully started; otherwise, false.

BeginInit()

Declaration
public override void BeginInit()
Overrides

BeginUpdate()

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()

BringIntoView(RadTreeNode)

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

Declaration
public void BringIntoView(RadTreeNode node)
Parameters
RadTreeNode node

The tree node to bring into view.

CancelEdit()

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

Declaration
public void CancelEdit()

ClearSelection()

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

Declaration
public virtual void ClearSelection()

CollapseAll()

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

Declaration
public void CollapseAll()

CollapseAll(RadTreeNodeCollection)

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

Declaration
public void CollapseAll(RadTreeNodeCollection nodes)
Parameters
RadTreeNodeCollection nodes

The collection of nodes to be collapsed.

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateChildItems(RadElement)

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
RadElement parent

The parent RadElement that will contain the child elements.
Overrides

CreateTreeViewElement()

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
RadTreeViewElement

A new RadTreeViewElement instance.

DeferRefresh()

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
System.IDisposable

An System.IDisposable object that triggers refresh when disposed.

Dispose(Boolean)

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
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

EndEdit()

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

Declaration
public bool EndEdit()
Returns
System.Boolean

True if the edit operation was successfully ended; otherwise, false.

EndInit()

Declaration
public override void EndInit()
Overrides

EndUpdate()

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()

Execute(Boolean, ICommand, Object[])

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
System.Boolean includeSubTrees

True to include subtrees in the command execution; otherwise, false.
ICommand command

The command to execute.
System.Object[] settings

Optional settings or parameters for the command.
Returns
System.Object

The result of the command execution, if any.

Execute(ICommand, Object[])

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

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

The command to execute.
System.Object[] settings

Optional settings or parameters for the command.
Returns
System.Object

The result of the command execution, if any.

ExecuteBatchCommand(RadTreeNode, Int32, ICommand, Object[])

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
RadTreeNode node

The node form which the execuition starts.
System.Int32 level

The level of nodes over which to execute the command. If -1 the entire subtree is traversed.
ICommand command

The command to execute.
System.Object[] settings

Parameters to pass the command prior to execution.
Returns
System.Collections.Generic.List<System.Object>

The results from the batch execution.

ExecuteBatchCommand(RadTreeNodeCollection, Int32, ICommand, Object[])

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
RadTreeNodeCollection nodes

The collection of nodes from which execution starts.
System.Int32 level

The level of nodes over which to execute the command. If -1, the entire subtree is traversed.
ICommand command

The command to execute on each node.
System.Object[] settings

Parameters to pass to the command prior to execution.
Returns
System.Collections.Generic.List<System.Object>

A list containing the results from the batch execution.

ExecuteScalarCommand(RadTreeNode, Int32, ICommand, Object[])

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
RadTreeNode node

The node from which execution starts.
System.Int32 level

The level of nodes over which to execute the command. If -1, the entire subtree is traversed.
ICommand command

The command to execute on each node.
System.Object[] settings

Parameters to pass to the command prior to execution.
Returns
System.Object

The first result from the batch execution.

ExpandAll()

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

Declaration
public void ExpandAll()

ExpandAll(RadTreeNodeCollection)

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

Declaration
public virtual void ExpandAll(RadTreeNodeCollection nodes)
Parameters
RadTreeNodeCollection nodes

The collection of nodes to be expanded.

Find(Predicate<RadTreeNode>)

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

Declaration
public RadTreeNode Find(Predicate<RadTreeNode> match)
Parameters
System.Predicate<RadTreeNode> match

A predicate function that defines the search criteria.
Returns
RadTreeNode

The first RadTreeNode that matches the predicate, or null if no match is found.

Find(String)

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

Declaration
public virtual RadTreeNode Find(string text)
Parameters
System.String text

The text to search for within node text.
Returns
RadTreeNode

The first RadTreeNode containing the specified text, or null if not found.

Find<T>(FindAction<T>, T)

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
FindAction<T> match

A function that defines the search criteria with a parameter.
T arg

The argument to pass to the search function.
Returns
RadTreeNode

The first RadTreeNode that matches the criteria, or null if no match is found.
Type Parameters
T

FindNodes(Predicate<RadTreeNode>)

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

Declaration
public RadTreeNode[] FindNodes(Predicate<RadTreeNode> match)
Parameters
System.Predicate<RadTreeNode> match

A predicate function that defines the search criteria.
Returns
RadTreeNode[]

An array of RadTreeNode objects that match the predicate.

FindNodes(String)

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

Declaration
public virtual RadTreeNode[] FindNodes(string text)
Parameters
System.String text

The text to search for within node text.
Returns
RadTreeNode[]

An array of RadTreeNode objects containing the specified text.

FindNodes<T>(FindAction<T>, T)

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
FindAction<T> match

A function that defines the search criteria with a parameter.
T arg

The argument to pass to the search function.
Returns
RadTreeNode[]

An array of RadTreeNode objects that match the criteria.
Type Parameters
T

ForEach(Action<RadTreeNode>)

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
System.Action<RadTreeNode> action

The action to execute for each tree node.

GetNodeAt(Point)

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

Declaration
public RadTreeNode GetNodeAt(Point pt)
Parameters
System.Drawing.Point pt

The point to evaluate and retrieve the node from.
Returns
RadTreeNode

The RadTreeNode at the specified point, or null if no node exists at that location.

GetNodeAt(Int32, Int32)

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

Declaration
public RadTreeNode GetNodeAt(int x, int y)
Parameters
System.Int32 x

The X coordinate to evaluate and retrieve the node from.
System.Int32 y

The Y coordinate to evaluate and retrieve the node from.
Returns
RadTreeNode

The RadTreeNode at the specified location, or null if no node exists at that location.

GetNodeByName(String)

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
System.String name

The name of the node to find.
Returns
RadTreeNode

The first RadTreeNode with the specified name, or null if not found.

GetNodeByName(String, RadTreeNode)

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
System.String name

The name of the node to find.
RadTreeNode rootNode

The root node to begin the search from.
Returns
RadTreeNode

The first RadTreeNode with the specified name, or null if not found.

GetNodeByPath(String)

Retrieves a tree node by following the specified hierarchical path. The path is parsed using the current PathSeparator value.

Declaration
public virtual RadTreeNode GetNodeByPath(string path)
Parameters
System.String path

The hierarchical path to the desired node.
Returns
RadTreeNode

The RadTreeNode at the specified path, or null if not found.

GetNodeByPath(String, String)

Retrieves a tree node by following the specified hierarchical path using a custom path separator. The path is parsed using the specified separator to locate the node.

Declaration
public virtual RadTreeNode GetNodeByPath(string path, string pathSeparator)
Parameters
System.String path

The hierarchical path to the desired node.
System.String pathSeparator

The custom path separator to use for parsing the path.
Returns
RadTreeNode

The RadTreeNode at the specified path, or null if not found.

GetNodeCount(Boolean)

Retrieves the total number of tree nodes in the tree view control.

Declaration
public int GetNodeCount(bool includeSubTrees)
Parameters
System.Boolean includeSubTrees

True to include nodes in all subtrees; false to count only top-level nodes.
Returns
System.Int32

The total number of tree nodes in the control.

IsInputKey(Keys)

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

LoadXML(Stream, Type[])

Loads tree view structure from an XML stream with support for additional custom types.

Declaration
public void LoadXML(Stream stream, params Type[] extraTypes)
Parameters
System.IO.Stream stream

The stream containing XML data to load.
System.Type[] extraTypes

Additional types that should be recognized during XML deserialization.

LoadXML(String, Type[])

Loads tree view structure from an XML file with support for additional custom types.

Declaration
public void LoadXML(string fileName, params Type[] extraTypes)
Parameters
System.String fileName

The path to the XML file to load.
System.Type[] extraTypes

Additional types that should be recognized during XML deserialization.

LoadXMLWithReader(XmlReader, Type[])

Loads tree view structure from an XML reader with support for additional custom types.

Declaration
protected virtual void LoadXMLWithReader(XmlReader reader, params Type[] extraTypes)
Parameters
System.Xml.XmlReader reader

The XML reader containing the tree structure data.
System.Type[] extraTypes

Additional types that should be recognized during XML deserialization.

OnBindingContextChanged(EventArgs)

Declaration
protected override void OnBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnClick(EventArgs)

Declaration
protected override void OnClick(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyPress(KeyPressEventArgs)

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

Overrides

OnLoad(Size)

Handles the load event and enables pan gesture support for touch interactions. This method is called when the control is loaded and initializes gesture-based navigation.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

The desired size for the control.
Overrides

OnLostFocus(EventArgs)

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseClick(MouseEventArgs)

Declaration
protected override void OnMouseClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseDoubleClick(MouseEventArgs)

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseEnter(EventArgs)

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Handles property change notifications and updates the tree view as needed.

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

The property change event arguments.
Overrides

OnThemeNameChanged(ThemeNameChangedEventArgs)

Processes Windows theme changes and updates the tree view appearance accordingly.

Declaration
protected override void OnThemeNameChanged(ThemeNameChangedEventArgs e)
Parameters
ThemeNameChangedEventArgs e

The theme change event arguments.
Overrides

ProcessCodedUIMessage(ref IPCMessage)

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

Overrides

SaveXML(Stream, Type[])

Saves the tree view structure to an XML stream with support for additional custom types.

Declaration
public void SaveXML(Stream stream, params Type[] extraTypes)
Parameters
System.IO.Stream stream

The stream to write XML data to.
System.Type[] extraTypes

Additional types that should be included in XML serialization.

SaveXML(String, Type[])

Saves the tree view structure to an XML file with support for additional custom types.

Declaration
public void SaveXML(string fileName, params Type[] extraTypes)
Parameters
System.String fileName

The path where the XML file should be saved.
System.Type[] extraTypes

Additional types that should be included in XML serialization.

SaveXMLWithWriter(TextWriter, Type[])

Saves the tree view structure to an XML writer with support for additional custom types.

Declaration
protected virtual void SaveXMLWithWriter(TextWriter writer, params Type[] extraTypes)
Parameters
System.IO.TextWriter writer

The text writer to save XML data to.
System.Type[] extraTypes

Additional types that should be included in XML serialization.

SelectAll()

Selects all tree nodes in the tree view when MultiSelect is enabled.

Declaration
public virtual void SelectAll()

SetError(String, RadTreeNode)

Sets an error message for a specific tree node, typically used for validation feedback.

Declaration
public void SetError(string text, RadTreeNode radTreeNode)
Parameters
System.String text

The error message text to display.
RadTreeNode radTreeNode

The tree node to associate with the error.

ToString()

Returns a string representation of this tree view control, including node count information.

Declaration
public override string ToString()
Returns
System.String

A string that represents the current tree view control.

UnwireEvents()

Removes event handler connections for the tree view control during cleanup. This method unsubscribes from events to prevent memory leaks when the control is disposed.

Declaration
protected virtual void UnwireEvents()

WireEvents()

Establishes event handler connections for the tree view control. This method subscribes to essential events like SelectedNodeChanged for proper functionality.

Declaration
protected virtual void WireEvents()

WndProc(ref Message)

Processes Windows messages for the tree view control, including context menu handling.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows message to process.
Overrides

Events

ContextMenuOpening

Occurs when a context menu is about to be opened for the tree view. This event allows customization of the context menu before it is displayed.

Declaration
public event TreeViewContextMenuOpeningEventHandler ContextMenuOpening
Event Type
TreeViewContextMenuOpeningEventHandler

CreateNode

Occurs when a new tree node is about to be created during data binding or programmatic operations. This event allows customization of node creation and assignment of custom node types.

Declaration
public event CreateTreeNodeEventHandler CreateNode
Event Type
CreateTreeNodeEventHandler

CreateNodeElement

Occurs when a new tree node element is about to be created for visual rendering. This event allows customization of the visual element that represents a tree node.

Declaration
public event CreateTreeNodeElementEventHandler CreateNodeElement
Event Type
CreateTreeNodeElementEventHandler

DataError

Occurs when a data binding error is encountered during tree view operations. This event allows handling and responding to data-related errors gracefully.

Declaration
public event TreeNodeDataErrorEventHandler DataError
Event Type
TreeNodeDataErrorEventHandler

DragEnded

Occurs after a drag operation has completed successfully. This event is raised when nodes have been moved or copied to their new location.

Declaration
public event RadTreeView.DragEndedHandler DragEnded
Event Type
RadTreeView.DragEndedHandler

DragEnding

Occurs when a drag operation is about to end, allowing cancellation of the drop operation. This event provides an opportunity to validate and potentially cancel the drag operation.

Declaration
public event RadTreeView.DragEndingHandler DragEnding
Event Type
RadTreeView.DragEndingHandler

DragOverNode

Occurs when dragged content is positioned over a tree node during a drag operation. This event allows customization of visual feedback and validation of drop targets.

Declaration
public event EventHandler<RadTreeViewDragCancelEventArgs> DragOverNode
Event Type
System.EventHandler<RadTreeViewDragCancelEventArgs>

DragStarted

Occurs after a drag operation has begun and the node is being dragged. This event indicates that the drag operation is now active.

Declaration
public event RadTreeView.DragStartedHandler DragStarted
Event Type
RadTreeView.DragStartedHandler

DragStarting

Occurs when a drag operation is about to begin, allowing cancellation of the operation. This event provides an opportunity to prevent certain nodes from being dragged.

Declaration
public event RadTreeView.DragStartingHandler DragStarting
Event Type
RadTreeView.DragStartingHandler

Edited

Occurs after a tree node has finished being edited and the changes have been applied. This event provides access to the edited node and the new value.

Declaration
public event TreeNodeEditedEventHandler Edited
Event Type
TreeNodeEditedEventHandler

Editing

Occurs before a tree node enters edit mode for text editing. This event allows validation and cancellation of the editing operation.

Declaration
public event TreeNodeEditingEventHandler Editing
Event Type
TreeNodeEditingEventHandler

EditorInitialized

Occurs when the active editor for node editing has been initialized. This event allows customization of the editor after it has been created and configured.

Declaration
public event TreeNodeEditorInitializedEventHandler EditorInitialized
Event Type
TreeNodeEditorInitializedEventHandler

EditorRequired

Occurs when the tree view requires an editor for node editing operations. This event allows custom editor selection and configuration for different node types.

Declaration
public event RadTreeView.EditorRequiredHandler EditorRequired
Event Type
RadTreeView.EditorRequiredHandler

ItemDrag

Occurs when the user begins dragging a tree node. This event is raised at the start of a drag operation when AllowDragDrop is enabled.

Declaration
public event RadTreeView.ItemDragHandler ItemDrag
Event Type
RadTreeView.ItemDragHandler

NodeAdded

Occurs after a tree node has been added to the tree view. This event provides access to the newly added node for initialization or logging purposes.

Declaration
public event RadTreeView.RadTreeViewEventHandler NodeAdded
Event Type
RadTreeView.RadTreeViewEventHandler

NodeAdding

Occurs before a tree node is added to the tree view, allowing cancellation of the operation. This event provides an opportunity to validate or prevent node addition.

Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeAdding
Event Type
RadTreeView.RadTreeViewCancelEventHandler

NodeCheckedChanged

Occurs after the checked state of a tree node has changed. This event is raised when CheckBoxes is enabled and a node's check state has been modified.

Declaration
public virtual event TreeNodeCheckedEventHandler NodeCheckedChanged
Event Type
TreeNodeCheckedEventHandler

NodeCheckedChanging

Occurs before the checked state of a tree node changes, allowing cancellation of the operation. This event is raised when CheckBoxes is enabled and a node's check state is about to change.

Declaration
public virtual event RadTreeView.RadTreeViewCancelEventHandler NodeCheckedChanging
Event Type
RadTreeView.RadTreeViewCancelEventHandler

NodeDataBound

Occurs after a tree node has been bound to a data item during data binding operations. This event allows customization of the node after it has been populated with data.

Declaration
public event RadTreeView.RadTreeViewEventHandler NodeDataBound
Event Type
RadTreeView.RadTreeViewEventHandler

NodeExpandedChanged

Occurs after a tree node has been expanded or collapsed. This event is raised when the expanded state of a node has been successfully changed.

Declaration
public event RadTreeView.TreeViewEventHandler NodeExpandedChanged
Event Type
RadTreeView.TreeViewEventHandler

NodeExpandedChanging

Occurs before a tree node is expanded or collapsed, allowing cancellation of the operation. This event provides an opportunity to validate or prevent expand/collapse actions.

Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeExpandedChanging
Event Type
RadTreeView.RadTreeViewCancelEventHandler

NodeFormatting

Occurs when a tree node needs to be formatted for display. This event allows customization of node appearance based on state or data.

Declaration
public event TreeNodeFormattingEventHandler NodeFormatting
Event Type
TreeNodeFormattingEventHandler

NodeMouseClick

Occurs when a mouse button is clicked on a tree node. This event provides access to the clicked node and mouse event details.

Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseClick
Event Type
RadTreeView.TreeViewEventHandler

NodeMouseDoubleClick

Occurs when a mouse button is double-clicked on a tree node. This event provides access to the double-clicked node and mouse event details.

Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseDoubleClick
Event Type
RadTreeView.TreeViewEventHandler

NodeMouseDown

Occurs when the user presses a mouse button while the cursor is over a tree node. This event provides access to the specific node and mouse button information.

Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseDown
Event Type
RadTreeView.TreeViewMouseEventHandler

NodeMouseEnter

Occurs when the mouse cursor enters the area of a tree node. This event is useful for implementing custom hover effects or tooltips.

Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseEnter
Event Type
RadTreeView.TreeViewEventHandler

NodeMouseHover

Occurs when the mouse cursor hovers over a tree node for an extended period. This event is typically used for displaying detailed tooltips or information.

Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseHover
Event Type
RadTreeView.TreeViewEventHandler

NodeMouseLeave

Occurs when the mouse cursor leaves the area of a tree node. This event is useful for cleaning up hover effects or hiding tooltips.

Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseLeave
Event Type
RadTreeView.TreeViewEventHandler

NodeMouseMove

Occurs when the user moves the mouse cursor within the area of a tree node. This event provides access to the specific node and mouse position information.

Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseMove
Event Type
RadTreeView.TreeViewMouseEventHandler

NodeMouseUp

Occurs when the user releases a mouse button while the cursor is over a tree node. This event provides access to the specific node and mouse button information.

Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseUp
Event Type
RadTreeView.TreeViewMouseEventHandler

NodeRemoved

Occurs after a tree node has been removed from the tree view. This event provides access to the removed node for cleanup or logging purposes.

Declaration
public event RadTreeView.RadTreeViewEventHandler NodeRemoved
Event Type
RadTreeView.RadTreeViewEventHandler

NodeRemoving

Occurs before a tree node is removed from the tree view, allowing cancellation of the operation. This event provides an opportunity to validate or prevent node removal.

Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeRemoving
Event Type
RadTreeView.RadTreeViewCancelEventHandler

NodesNeeded

Occurs when child nodes need to be loaded in lazy loading mode. This event is raised when LazyMode is enabled and a node is expanded for the first time.

Declaration
public event NodesNeededEventHandler NodesNeeded
Event Type
NodesNeededEventHandler

SelectedNodeChanged

Occurs after a tree node has been selected. This event is raised when the SelectedNode property changes.

Declaration
public virtual event RadTreeView.RadTreeViewEventHandler SelectedNodeChanged
Event Type
RadTreeView.RadTreeViewEventHandler

SelectedNodeChanging

Occurs before a tree node selection changes, allowing cancellation of the selection. This event provides an opportunity to validate and potentially prevent node selection.

Declaration
public virtual event RadTreeView.RadTreeViewCancelEventHandler SelectedNodeChanging
Event Type
RadTreeView.RadTreeViewCancelEventHandler

SelectedNodesChanged

Occurs when the SelectedNodes collection has been modified. This event is raised when nodes are added to or removed from the selection.

Declaration
public virtual event EventHandler<RadTreeViewEventArgs> SelectedNodesChanged
Event Type
System.EventHandler<RadTreeViewEventArgs>

SelectedNodesCleared

Occurs when all selected nodes have been cleared from the SelectedNodes collection. This event is raised when the selection is programmatically or interactively cleared.

Declaration
public virtual event EventHandler SelectedNodesCleared
Event Type
System.EventHandler

ShowExpander

Occurs when the tree view needs to determine whether to show an expander for a node in lazy loading mode. This event is raised when LazyMode is enabled and the control needs to display expand indicators.

Declaration
public event RadTreeView.TreeViewShowExpanderEventHandler ShowExpander
Event Type
RadTreeView.TreeViewShowExpanderEventHandler

ValidationError

Occurs when editor validation fails during the node editing process. This event is raised when the entered value does not meet validation criteria.

Declaration
public event EventHandler ValidationError
Event Type
System.EventHandler

ValueChanged

Occurs when the editor has finished editing and the new value has been committed. This event is raised after the node value has been successfully changed.

Declaration
public event TreeNodeValueChangedEventHandler ValueChanged
Event Type
TreeNodeValueChangedEventHandler

ValueChanging

Occurs when the editor value is in the process of being changed during node editing. This event allows validation and modification of the value before it is committed.

Declaration
public event TreeNodeValueChangingEventHandler ValueChanging
Event Type
TreeNodeValueChangingEventHandler

ValueValidating

Occurs when the editor value is being validated during the editing process. This event allows custom validation logic and can prevent invalid values from being accepted.

Declaration
public event TreeNodeValidatingEventHandler ValueValidating
Event Type
TreeNodeValidatingEventHandler

Explicit Interface Implementations

ISupportRootUIAutomation.DisposeUIAutomationProvider()

Clears the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.DisposeUIAutomationProvider()
Implements

ISupportRootUIAutomation.InitializeUIAutomationProvider()

Creates the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.InitializeUIAutomationProvider()
Implements

ISupportRootUIAutomation.RootUIAutomationManager

Gets the UI Automation Manager.

Declaration
IRootUIAutomationManager ISupportRootUIAutomation.RootUIAutomationManager { get; }
Returns
IRootUIAutomationManager

Implements

ISupportRootUIAutomation.UIAutomationProvider

Gets the UI Automation Provider.

Declaration
IRadRawElementProviderFragmentRoot ISupportRootUIAutomation.UIAutomationProvider { get; }
Returns
IRadRawElementProviderFragmentRoot

Implements

Extension Methods