Class RadTreeView

Displays a hierarchical collection of labeled items, each represented by a RadTreeNode.

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

Constructors

RadTreeView()

Declaration
public RadTreeView()

Properties

ActiveEditor

Gets the active editor in the tree.

Declaration
public IInputEditor ActiveEditor { get; }
Property Value
IInputEditor

The IValueEditor if any.

AllowAdd

Gets or sets a value indicating whether adding new nodes is allowed.

Declaration
public virtual bool AllowAdd { get; set; }
Property Value
System.Boolean

true if [allow edit]; otherwise, false.

AllowArbitraryItemHeight

Gets or sets a value indicating whether nodes can have different height.

Declaration
public virtual bool AllowArbitraryItemHeight { get; set; }
Property Value
System.Boolean

The default value is false.

AllowDefaultContextMenu

Gets or sets a value indicating whether the default context menu is enabled.

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

The default value is false.

AllowDragDrop

Gets or sets a value indicating whether drag and drop operation with treeview nodes is enabled.

Declaration
public virtual bool AllowDragDrop { get; set; }
Property Value
System.Boolean

The default value is false.
See Also

AllowEdit

Gets or sets a value indicating whether editing is allowed.

Declaration
public virtual bool AllowEdit { get; set; }
Property Value
System.Boolean

true if [allow edit]; otherwise, false.

AllowPlusMinusAnimation

Gets or sets a value indicating whether animation of collapse/expand images is enabled.

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

The default value is false.
See Also

AllowRemove

Gets or sets a value indicating whether removing nodes is allowed.

Declaration
public virtual bool AllowRemove { get; set; }
Property Value
System.Boolean

true if [allow edit]; otherwise, false.

AutoCheckChildNodes

Gets or sets a value indicating whether the child nodes should be auto checked when RadTreeView is in tri state mode

Declaration
public virtual bool AutoCheckChildNodes { get; set; }
Property Value
System.Boolean

The default value is false.

AutoScroll

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

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

BackColor

RadTreeView consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

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

Declaration
public virtual bool CheckBoxes { get; set; }
Property Value
System.Boolean

The default value is false.

CheckedMember

Gets or sets the checked member.

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

The checked member.

CheckedNodes

Gets the checked nodes.

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

The checked nodes.

ChildMember

Gets or sets the child member.

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

The child member.

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 list or table in the data source for which the RadTreeView is displaying data.

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

DataSource

Gets or sets the data source that the RadTreeView is displaying data for.

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

Implements

DefaultSize

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

DisplayMember

Gets or sets the display member.

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

The display member.

DropHintColor

Gets or sets the color of the drop hint.

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

The default value is black.
Remarks

The drop feedback is a visual cue that assists the user with information where to drop during the drag and drop operation.

See Also

EnableDeferredScrolling

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

EnableKineticScrolling

Gets or sets a value indicating whether the kinetic scrolling function is enabled.

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

ExpandAnimation

Gets or sets the type of the ExpandAnimation.

Declaration
public ExpandAnimation ExpandAnimation { get; set; }
Property Value
ExpandAnimation

The default value is ExpandAnimation.Opacity.
See Also

ExpandMode

Gets or sets a value indicating whether single node expand is enabled.

Declaration
public ExpandMode ExpandMode { get; set; }
Property Value
ExpandMode

Filter

Gets or sets the filter.

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

The filter.

FilterDescriptors

Gets the filter descriptors.

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

The filter descriptors.
Implements

FindStringComparer

Gets or sets the string comparer used by the keyboard navigation functionality.

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

ForeColor

RadTreeView consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

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

Overrides

FullRowSelect

Gets or sets a value indicating whether the highlight spans the width of the tree view.

Declaration
public virtual bool FullRowSelect { get; set; }
Property Value
System.Boolean

The default value is false.

HideSelection

Gets or sets a value indicating whether [hide selection].

Declaration
public virtual bool HideSelection { get; set; }
Property Value
System.Boolean

true if [hide selection]; otherwise, false.

HotTracking

Gets or sets a value indicating whether [hot tracking].

Declaration
public virtual bool HotTracking { get; set; }
Property Value
System.Boolean

true if [hot tracking]; otherwise, false.

HScrollBar

Gets the Horizontal scroll bar.

Declaration
public RadScrollBarElement HScrollBar { get; }
Property Value
RadScrollBarElement

The Horizontal scroll bar.

ImageIndex

The default image index for nodes.

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

The index of the image.

ImageKey

The default image key for nodes.

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

The image key.

IsEditing

Gets a value indicating whether there is an open editor in the tree view.

Declaration
public bool IsEditing { get; }
Property Value
System.Boolean

ItemHeight

Gets or sets the height of the item.

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

The height of the item.

KeyboardSearchEnabled

Gets or sets a value that determines whether the user can navigate to an item by typing when RadTreeView is focused.

Declaration
public virtual bool KeyboardSearchEnabled { get; set; }
Property Value
System.Boolean

The default value is false.

KeyboardSearchResetInterval

Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset.

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

The default value is 300ms.

LazyMode

Gets or sets a value indicating whether the TreeView load child Nodes collection in NodesNeeded event only when Parent nodes expanded.

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

true if [lazy mode]; otherwise, false.

LineColor

Gets or sets the color of the line.

Declaration
public virtual Color LineColor { get; set; }
Property Value
System.Drawing.Color

The color of the line.

LineStyle

Gets or sets the line style.

Declaration
public virtual TreeLineStyle LineStyle { get; set; }
Property Value
TreeLineStyle

A TreeLineStyle that represents the style used for the lines between the nodes. The default is TreeLineStyle.
See Also

LineWidth

Gets or sets the line width.

Declaration
public virtual float LineWidth { get; set; }
Property Value
System.Single

The System.Single with which the lines between the nodes will be painted. The default is System.Single.

MultiSelect

Gets or sets a value indicating whether the user is allowed to select more than one tree node at time

Declaration
public virtual bool MultiSelect { get; set; }
Property Value
System.Boolean

true if [multi select]; otherwise, false.

Nodes

Gets the collection of tree nodes that are assigned to the tree view control.

Declaration
public virtual RadTreeNodeCollection Nodes { get; }
Property Value
RadTreeNodeCollection

A System.Windows.Forms.TreeNodeCollection that represents the tree nodes assigned to the tree view control.

ParentMember

Gets or sets the parent member.

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

The parent member.

PathSeparator

Gets or sets the path separator.

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

The path separator.

PlusMinusAnimationStep

Gets or sets the opacity animation step for expand/collapse animation.

Declaration
public double PlusMinusAnimationStep { get; set; }
Property Value
System.Double

Returns a double value from double.Epsilon to 1 representing the opacity changing step with which the plus minus buttons are animated. The default value is 0.025.

RadContextMenu

Gets or sets the shortcut menu associated with the control.

Declaration
public virtual RadContextMenu RadContextMenu { get; set; }
Property Value
RadContextMenu

RelationBindings

Contains data binding settings for related data.

Declaration
public RelationBindingCollection RelationBindings { get; }
Property Value
RelationBindingCollection

SelectedNode

Gets or sets the selected node.

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

The selected node.

SelectedNodes

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

ShowDragHint

Gets or sets a value indicating whether [show drop feedback].

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

true if [show drop feedback]; otherwise, false.

ShowDropHint

Gets or sets a value indicating whether [show drop feedback].

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

true if [show drop feedback]; otherwise, false.

ShowExpandCollapse

Gets or sets a value indicating whether expand/collapse (plus-minus) buttons are shown next to nodes with children.

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

The default value is true.

ShowLines

Gets or sets a value indicating whether [show lines].

Declaration
public virtual bool ShowLines { get; set; }
Property Value
System.Boolean

true if [show lines]; otherwise, false.

ShowNodeToolTips

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

ShowRootLines

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

SortDescriptors

Gets the sort descriptors.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

The sort descriptors.

SortOrder

Gets or sets the sort order of Nodes.

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

The sort order.

SpacingBetweenNodes

Gets or sets the spacing in pixels between nodes.

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

The default value is 0.

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 a value indicating the default tree view toggle mode.

Declaration
public virtual ToggleMode ToggleMode { get; set; }
Property Value
ToggleMode

ToggleStateConverter

Gets or sets a System.ComponentModel.TypeConverter that will be used to convert the toggle state of the checkboxes to the underlying data type it is bound to.

Declaration
public virtual TypeConverter ToggleStateConverter { get; set; }
Property Value
System.ComponentModel.TypeConverter

TopNode

Gets the top node.

Declaration
public RadTreeNode TopNode { get; }
Property Value
RadTreeNode

The top node.

TreeIndent

Gets or sets the indent.

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

The indent.

TreeViewElement

Gets the tree view element.

Declaration
public virtual RadTreeViewElement TreeViewElement { get; }
Property Value
RadTreeViewElement

The tree view element.

TreeViewXml

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

TriStateMode

Gets or sets a value indicating whether tri state mode is enabled.

Declaration
public virtual bool TriStateMode { get; set; }
Property Value
System.Boolean

The default value is false.

ValueMember

Gets or sets the value member.

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

The value member.

VisibleCount

Gets the visible count.

Declaration
public int VisibleCount { get; }
Property Value
System.Int32

The visible count.

VScrollBar

Gets the Vertical scroll bar.

Declaration
public RadScrollBarElement VScrollBar { get; }
Property Value
RadScrollBarElement

The Vertical scroll bar.

Methods

AddNodeByPath(String)

Creates a new node and adds a node by path. The label of the new node will be the text after the last separator.

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

Where the node should be added.
Returns
RadTreeNode

The new node if the operation is successful.

AddNodeByPath(String, String)

Creates a new node and adds a node by path. The label of the new node will be the text after the last separator.

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

Where the node should be added.
System.String pathSeparator

The path separator.
Returns
RadTreeNode

The new node if the operation is successful.

BeginEdit()

Begins the edit.

Declaration
public bool BeginEdit()
Returns
System.Boolean

BeginInit()

Declaration
public override void BeginInit()
Overrides

BeginUpdate()

Disables any update of the tree view.

Declaration
public void BeginUpdate()

BringIntoView(RadTreeNode)

Brings the into view.

Declaration
public void BringIntoView(RadTreeNode node)
Parameters
RadTreeNode node

The node.

CancelEdit()

Close the currently active editor and discard changes.

Declaration
public void CancelEdit()

ClearSelection()

Declaration
public virtual void ClearSelection()

CollapseAll()

Collapses all the tree nodes.

Declaration
public void CollapseAll()

CollapseAll(RadTreeNodeCollection)

Collapses all nodes in a given collection.

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)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateTreeViewElement()

Declaration
protected virtual RadTreeViewElement CreateTreeViewElement()
Returns
RadTreeViewElement

DeferRefresh()

Defers the refresh.

Declaration
public virtual IDisposable DeferRefresh()
Returns
System.IDisposable

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

EndEdit()

Commits any changes and ends the edit operation on the current cell.

Declaration
public bool EndEdit()
Returns
System.Boolean

EndInit()

Declaration
public override void EndInit()
Overrides

EndUpdate()

Ends the update.

Declaration
public void EndUpdate()

Execute(Boolean, ICommand, Object[])

Executes the specified command include sub trees.

Declaration
public object Execute(bool includeSubTrees, ICommand command, params object[] settings)
Parameters
System.Boolean includeSubTrees

if set to true [include sub trees].
ICommand command

The command.
System.Object[] settings

The settings.
Returns
System.Object

Execute(ICommand, Object[])

Executes the specified command.

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

The command.
System.Object[] settings

The settings.
Returns
System.Object

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

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

The nodes 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.

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

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

Declaration
public static object ExecuteScalarCommand(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.Object

The first result from the batch execution.

ExpandAll()

Expands all the tree nodes.

Declaration
public void ExpandAll()

ExpandAll(RadTreeNodeCollection)

Expands all nodes in a given collection.

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

The collection of nodes to be expanded.

Find(Predicate<RadTreeNode>)

Finds the specified match.

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

The match.
Returns
RadTreeNode

Find(String)

Finds the specified text.

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

The text.
Returns
RadTreeNode

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

Finds the specified match.

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

The match.
T arg

The argument.
Returns
RadTreeNode

Type Parameters
T

FindNodes(Predicate<RadTreeNode>)

Finds the nodes.

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

The match.
Returns
RadTreeNode[]

FindNodes(String)

Finds the nodes.

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

The text.
Returns
RadTreeNode[]

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

Finds the nodes.

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

The match.
T arg

The argument.
Returns
RadTreeNode[]

Type Parameters
T

ForEach(Action<RadTreeNode>)

Execute the specified action for every RadTreeNode in the tree

Declaration
public void ForEach(Action<RadTreeNode> action)
Parameters
System.Action<RadTreeNode> action

GetNodeAt(Point)

Retrieves the tree node that is at the specified point.

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

The System.Drawing.Point to evaluate and retrieve the node from.
Returns
RadTreeNode

The System.Windows.Forms.TreeNode at the specified point, in tree view (client) coordinates, or null if there is no node at that location.

GetNodeAt(Int32, Int32)

Retrieves the tree node at the point with the specified coordinates.

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

The System.Drawing.Point.X position to evaluate and retrieve the node from.
System.Int32 y

The System.Drawing.Point.Y position to evaluate and retrieve the node from.
Returns
RadTreeNode

The System.Windows.Forms.TreeNode at the specified location, in tree view (client) coordinates, or null if there is no node at that location.

GetNodeByName(String)

Gets a node with the specified name.

Declaration
public RadTreeNode GetNodeByName(string name)
Parameters
System.String name

The name of the node.
Returns
RadTreeNode

A node with the specified name.

GetNodeByName(String, RadTreeNode)

Gets a node with the specified name.

Declaration
public RadTreeNode GetNodeByName(string name, RadTreeNode rootNode)
Parameters
System.String name

The name of the node.
RadTreeNode rootNode

The node which the should be taken as a root.
Returns
RadTreeNode

A node with the specified name.

GetNodeByPath(String)

Gets a node by specifying a path to it.

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

The path to the node.
Returns
RadTreeNode

The node if found.

GetNodeByPath(String, String)

Gets a node by specifying a path to it.

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

The path to the node.
System.String pathSeparator

The path separator.
Returns
RadTreeNode

The node if found.

GetNodeCount(Boolean)

Retrieves the number of tree nodes, optionally including those in all subtrees, assigned to the tree view control.

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

The number of tree nodes, optionally including those in all subtrees, assigned to the tree view control.
Returns
System.Int32

IsInputKey(Keys)

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

Returns
System.Boolean

Overrides

LoadXML(Stream, Type[])

Loads the XML.

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

The stream.
System.Type[] extraTypes

The extra types that will be load

LoadXML(String, Type[])

Loads the XML.

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

Name of the file.
System.Type[] extraTypes

The extra types that will be load

LoadXMLWithReader(XmlReader, Type[])

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

System.Type[] extraTypes

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)

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

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)

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

Overrides

OnThemeNameChanged(ThemeNameChangedEventArgs)

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

Overrides

ProcessCodedUIMessage(ref IPCMessage)

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

Overrides

SaveXML(Stream, Type[])

Saves the XML.

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

The stream.
System.Type[] extraTypes

The extra types that will be saved

SaveXML(String, Type[])

Saves the XML.

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

Name of the file.
System.Type[] extraTypes

The extra types that will be saved

SaveXMLWithWriter(TextWriter, Type[])

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

System.Type[] extraTypes

SelectAll()

Declaration
public virtual void SelectAll()

SetError(String, RadTreeNode)

Sets the error.

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

The text.
RadTreeNode radTreeNode

The RAD tree node.

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents this instance.

UnwireEvents()

Declaration
protected virtual void UnwireEvents()

WireEvents()

Declaration
protected virtual void WireEvents()

WndProc(ref Message)

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

Overrides

Events

ContextMenuOpening

Occurs when opening the context menu.

Declaration
public event TreeViewContextMenuOpeningEventHandler ContextMenuOpening
Event Type
TreeViewContextMenuOpeningEventHandler

CreateNode

Occurs when a new node is going to be created.

Declaration
public event CreateTreeNodeEventHandler CreateNode
Event Type
CreateTreeNodeEventHandler

CreateNodeElement

Occurs when a new node element is going to be created.

Declaration
public event CreateTreeNodeElementEventHandler CreateNodeElement
Event Type
CreateTreeNodeElementEventHandler

DataError

Occurs when the RadTreeView report the data error.

Declaration
public event TreeNodeDataErrorEventHandler DataError
Event Type
TreeNodeDataErrorEventHandler

DragEnded

Occurs when a drag has ended

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

DragEnding

Occurs when a drag is ending

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

DragOverNode

Occurs when drag feedback is needed for a node.

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

DragStarted

Occurs when a drag has started

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

DragStarting

Occurs when a drag is starting

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

Edited

Occurs after the tree node label text is edited.

Declaration
public event TreeNodeEditedEventHandler Edited
Event Type
TreeNodeEditedEventHandler

Editing

Occurs before the tree node label text is edited.

Declaration
public event TreeNodeEditingEventHandler Editing
Event Type
TreeNodeEditingEventHandler

EditorInitialized

Occurs when initializing the active editor.

Declaration
public event TreeNodeEditorInitializedEventHandler EditorInitialized
Event Type
TreeNodeEditorInitializedEventHandler

EditorRequired

Occurs when TreeView required editor.

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

ItemDrag

Occurs when the user begins dragging an item.

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

NodeAdded

Occurs after a node is being added.

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

NodeAdding

Occurs before a node is being added.

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

NodeCheckedChanged

Occurs when the value of the Checked property of a RadTreeNode is changed.

Declaration
public virtual event TreeNodeCheckedEventHandler NodeCheckedChanged
Event Type
TreeNodeCheckedEventHandler

NodeCheckedChanging

Occurs when the value of the Checked property of a RadTreeNode is changing.

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

NodeDataBound

Occurs after a node is bound to a data item.

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

NodeExpandedChanged

Occurs after the value of the Expanded property of a tree node is changed.

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

NodeExpandedChanging

Occurs before the value of the Expanded property of a tree node is changed.

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

NodeFormatting

Occurs when the node changes its state and needs to be formatted.

Declaration
public event TreeNodeFormattingEventHandler NodeFormatting
Event Type
TreeNodeFormattingEventHandler

NodeMouseClick

Occurs when a mouse button is clicked inside a TreeNodeElement The event arguments can be cast to RadTreeViewMouseEventArgs in order to access the original System.Windows.Forms.MouseEventArgs.

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

NodeMouseDoubleClick

Occurs when a mouse button is double clicked inside a TreeNodeElement The event arguments can be cast to RadTreeViewMouseEventArgs in order to access the original System.Windows.Forms.MouseEventArgs.

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

NodeMouseDown

Occurs when the user presses a mouse button over a RadTreeNode.

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

NodeMouseEnter

Occurs when the mouse enters the area of a RadTreeNode.

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

NodeMouseHover

Occurs when the mouse hovers over a RadTreeNode.

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

NodeMouseLeave

Occurs when the mouse leaves the area of a RadTreeNode.

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

NodeMouseMove

Occurs when the user moves the mouse in the area of a RadTreeNode.

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

NodeMouseUp

Occurs when the user releases a mouse button over a RadTreeNode.

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

NodeRemoved

Occurs after a node is removed.

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

NodeRemoving

Occurs before a node is removed.

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

NodesNeeded

Occurs when the Nodes collection requires to be populated in Load-On-Demand mode using LazyTreeNodeProvider.

Declaration
public event NodesNeededEventHandler NodesNeeded
Event Type
NodesNeededEventHandler

SelectedNodeChanged

Occurs after the tree node is selected. For more information about handling events, see also SelectedNodeChanging.

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

SelectedNodeChanging

Occurs before a tree node is selected.

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

SelectedNodesChanged

Occurs when SelectedNodes collection has been changed.

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

SelectedNodesCleared

Occurs when selected nodes has been cleared.

Declaration
public virtual event EventHandler SelectedNodesCleared
Event Type
System.EventHandler

ShowExpander

Occurs when the RadTreeView NodesNeeded event is handled and LazyMode property is true.

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

ValidationError

Occurs when editor validating fails.

Declaration
public event EventHandler ValidationError
Event Type
System.EventHandler

ValueChanged

Occurs when the editor finished the value editing.

Declaration
public event TreeNodeValueChangedEventHandler ValueChanged
Event Type
TreeNodeValueChangedEventHandler

ValueChanging

Occurs when the editor is changing the value during the editing process.

Declaration
public event TreeNodeValueChangingEventHandler ValueChanging
Event Type
TreeNodeValueChangingEventHandler

ValueValidating

Occurs when the editor changed the value editing.

Declaration
public event TreeNodeValidatingEventHandler ValueValidating
Event Type
TreeNodeValidatingEventHandler

Extension Methods