ClassRadTreeViewElement
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadTreeViewElement : VirtualizedScrollPanel<RadTreeNode, TreeNodeElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IDataItemSource
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementScrollViewElement<VirtualizedStackContainer<RadTreeNode>>VirtualizedScrollPanel<RadTreeNode, TreeNodeElement>RadTreeViewElement
Derived Classes:
Implements:
Inherited Members
Constructors
RadTreeViewElement()
Declaration
public RadTreeViewElement()
Fields
AllowArbitraryItemHeightProperty
Declaration
public static RadProperty AllowArbitraryItemHeightProperty
Field Value
AllowPlusMinusAnimationProperty
Declaration
public static RadProperty AllowPlusMinusAnimationProperty
Field Value
AlternatingRowColorProperty
Declaration
public static RadProperty AlternatingRowColorProperty
Field Value
CollapseImageProperty
Declaration
public static RadProperty CollapseImageProperty
Field Value
ExpandAnimationProperty
Declaration
public static RadProperty ExpandAnimationProperty
Field Value
FullRowSelectProperty
Declaration
public static RadProperty FullRowSelectProperty
Field Value
HoveredCollapseImageProperty
Declaration
public static RadProperty HoveredCollapseImageProperty
Field Value
HoveredExpandImageProperty
Declaration
public static RadProperty HoveredExpandImageProperty
Field Value
ItemDropHintProperty
Declaration
public static RadProperty ItemDropHintProperty
Field Value
PlusMinusAnimationStepProperty
Declaration
public static RadProperty PlusMinusAnimationStepProperty
Field Value
ShowExpandCollapseProperty
Declaration
public static RadProperty ShowExpandCollapseProperty
Field Value
ShowRootLinesProperty
Declaration
public static RadProperty ShowRootLinesProperty
Field Value
Properties
ActiveEditor
Gets or sets the active editor.
Declaration
public IInputEditor ActiveEditor { get; }
Property Value
The active editor.
AllowAdd
Gets or sets a value indicating whether [allow edit].
Declaration
public virtual bool AllowAdd { get; set; }
Property Value
true if [allow edit]; otherwise, false.
AllowAlternatingRowColor
Gets or sets a value indicating whether to show rows with alternating row colors.
Declaration
public virtual bool AllowAlternatingRowColor { get; set; }
Property Value
AllowArbitraryItemHeight
Gets or sets a value indicating whether nodes can have different height.
Declaration
[Browsable(true)]
public virtual bool AllowArbitraryItemHeight { get; set; }
Property Value
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
The default value is false.
AllowDragDrop
Gets or sets a value indicating whether [allow drag drop].
Declaration
public virtual bool AllowDragDrop { get; set; }
Property Value
true if [allow drag drop]; otherwise, false.
AllowEdit
Gets or sets a value indicating whether [allow edit].
Declaration
public bool AllowEdit { get; set; }
Property Value
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
The default value is false.
AllowRemove
Gets or sets a value indicating whether [allow edit].
Declaration
public virtual bool AllowRemove { get; set; }
Property Value
true if [allow edit]; otherwise, false.
AlternatingRowColor
Gets or sets the alternating row color.
Declaration
public virtual Color AlternatingRowColor { get; set; }
Property Value
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
The default value is false.
AutoScrollOnClick
Gets or sets a value indicating whether to scroll horizontally RadTreeView to ensure that the clicked node is visible.
Declaration
[Browsable(true)]
public bool AutoScrollOnClick { get; set; }
Property Value
BindingContext
Gets or sets the binding context.
Declaration
public override BindingContext BindingContext { get; set; }
Property Value
The binding context.
Overrides
Implements
CheckBoxes
Gets or sets a value indicating whether [check boxes].
Declaration
public virtual bool CheckBoxes { get; set; }
Property Value
true if [check boxes]; otherwise, false.
CheckedMember
Gets or sets a property name which will be used to extract the checked state of the data items. The value of the property with this name will be available via the Checked property of every RadTreeNode.
Declaration
public virtual string CheckedMember { get; set; }
Property Value
CheckedNodes
Gets the checked nodes.
Declaration
public virtual CheckedTreeNodeCollection CheckedNodes { get; }
Property Value
The checked nodes.
ChildMember
Gets or sets a property name which will be used to define a relation of the data items.
CollapseImage
Gets or sets the expand image
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image CollapseImage { get; set; }
Property Value
Comparer
Gets or sets the default sort Comparer for RadTreeView. The default comparer compares the nodes according to their text.
Declaration
[Browsable(false)]
public IComparer<RadTreeNode> Comparer { get; set; }
Property Value
IComparer<RadTreeNode>
ContextMenu
Gets or sets the context menu.
Declaration
public virtual RadContextMenu ContextMenu { get; set; }
Property Value
The context menu.
DataMember
Gets or sets the name of the list or table in the data source for which the RadTreeViewElement is displaying data.
DataSource
Gets or sets the data source that the RadTreeView is displaying data for.
DisplayMember
Gets or sets a property name which will be used to extract the text of the data items. The value of the property with this name will be available via the Text property of every RadTreeNode.
Declaration
public virtual string DisplayMember { get; set; }
Property Value
DragDropService
Gets or sets the drag drop service used when dragging nodes within RadTreeView or between different instances of RadTreeView.
Declaration
public TreeViewDragDropService DragDropService { get; set; }
Property Value
The drag drop service.
EditMode
Gets or sets the default RadTreeNode edit mode.
Declaration
[Browsable(false)]
public virtual TreeNodeEditMode EditMode { get; set; }
Property Value
The edit mode.
EnableDeferredScrolling
Declaration
[Browsable(false)]
public bool EnableDeferredScrolling { get; set; }
Property Value
EnableKineticScrolling
Gets or sets a value indicating whether the kinetic scrolling function is enabled.
Declaration
[Browsable(true)]
public bool EnableKineticScrolling { get; set; }
Property Value
ExpandAnimation
Gets or sets the type of the ExpandAnimation.
Declaration
public ExpandAnimation ExpandAnimation { get; set; }
Property Value
The default value is ExpandAnimation.Opacity.
ExpandImage
Gets or sets the expand image
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image ExpandImage { get; set; }
Property Value
ExpandMode
Gets or sets a value indicating whether single node expand is enabled.
Declaration
[Browsable(false)]
public ExpandMode ExpandMode { get; set; }
Property Value
ExpandTimerInterval
Gets or sets the expand timer interval - this is the interval of time in milliseconds which will pass before a hovered node is being expanded during drag and drop operation.
Declaration
public int ExpandTimerInterval { get; set; }
Property Value
The expand timer interval.
Filter
Gets or sets the filter.
Declaration
[Browsable(false)]
public virtual object Filter { get; set; }
Property Value
The filter.
FilterDescriptors
Gets the filter descriptors.
Declaration
[Browsable(false)]
public virtual FilterDescriptorCollection FilterDescriptors { get; }
Property Value
The filter descriptors.
FilterPredicate
Provides a callback so that the default filtering expression parser can be substituted.
Declaration
[Browsable(false)]
public virtual Predicate<RadTreeNode> FilterPredicate { get; set; }
Property Value
FindStringComparer
Gets or sets an object that implements IFindStringComparer. The value of this property is used in the keyboard search functionality.
Declaration
public virtual IFindStringComparer FindStringComparer { get; set; }
Property Value
FirstVisibleIndex
Gets the index of the first visible node.
FullRowSelect
Gets or sets a value indicating whether to select the full row.
Declaration
[Browsable(true)]
public virtual bool FullRowSelect { get; set; }
Property Value
The default value is false.
HideSelection
Gets or sets a value indicating whether [hide selection].
Declaration
public virtual bool HideSelection { get; set; }
Property Value
true if [hide selection]; otherwise, false.
HorizontalScrollState
Gets or sets a property that controls the visibility of the horizontal scrollbar.
Declaration
[Browsable(true)]
public ScrollState HorizontalScrollState { get; set; }
Property Value
HotTracking
Gets or sets a value indicating whether [hot tracking].
Declaration
public virtual bool HotTracking { get; set; }
Property Value
true if [hot tracking]; otherwise, false.
HoveredCollapseImage
Gets or sets the hovered collapse image
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image HoveredCollapseImage { get; set; }
Property Value
HoveredExpandImage
Gets or sets the hovered expand image
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image HoveredExpandImage { get; set; }
Property Value
ImageIndex
The default image index for nodes.
Declaration
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public override int ImageIndex { get; set; }
Property Value
The index of the image.
Overrides
ImageKey
The default image key for nodes.
Declaration
[RelatedImageList("ImageList")]
[TypeConverter(typeof(ImageKeyConverter))]
public override string ImageKey { get; set; }
Property Value
The image key.
Overrides
IsEditing
Gets a value indicating whether there is an open editor in the tree view.
IsInDesignMode
Gets or a value indicating whether the control is in design mode.
Declaration
[Browsable(false)]
public bool IsInDesignMode { get; }
Property Value
ItemDropHint
Gets or sets the RadImageShape instance which describes the hint that indicates where an item will be dropped after a drag operation.
Declaration
[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape ItemDropHint { get; set; }
Property Value
ItemHeight
Gets or sets the height of the item.
Declaration
public int ItemHeight { get; set; }
Property Value
The height of the item.
KeyboardSearchEnabled
Gets or sets a value that determines whether the user can navigate to an item by typing when RadTreeViewElement is focused. The default value is false.
Declaration
public virtual bool KeyboardSearchEnabled { get; set; }
Property Value
KeyboardSearchResetInterval
Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset. The default value is 300.
Declaration
public virtual int KeyboardSearchResetInterval { get; set; }
Property Value
LastNode
Gets the last node.
Declaration
public RadTreeNode LastNode { get; }
Property Value
The last node.
LazyMode
Gets or sets a value indicating whether the TreeView load child Nodes collection in NodesNeeded event only when Parend nodes expanded.
Declaration
[Browsable(false)]
public bool LazyMode { get; set; }
Property Value
true if [lazy mode]; otherwise, false.
LineColor
Gets or sets the color of the lines connecting the nodes in the tree view.
LineStyle
Gets or sets the line style.
Declaration
public virtual TreeLineStyle LineStyle { get; set; }
Property Value
A TreeLineStyle that represents the style used for the lines between the nodes. The default is TreeLineStyle.
LineWidth
Gets or sets the line width.
MultiSelect
Gets or sets a value indicating whether [multi select].
Declaration
public virtual bool MultiSelect { get; set; }
Property Value
true if [multi select]; otherwise, false.
NodeSpacing
Gets or sets the vertical spacing among nodes.
Nodes
Gets the nodes.
Declaration
public RadTreeNodeCollection Nodes { get; }
Property Value
The nodes.
ParentMember
Gets or sets a property name which will be used to define a relation of the data items.
Declaration
public virtual string ParentMember { get; set; }
Property Value
PathSeparator
Gets or sets the path separator.
Declaration
[Browsable(false)]
public virtual string PathSeparator { get; set; }
Property Value
The path separator.
PlusMinusAnimationStep
Gets or sets the opacity animation step for expand/collapse animation.
Declaration
[Browsable(false)]
public double PlusMinusAnimationStep { get; set; }
Property Value
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.
RelationBindings
Contains data binding settings for related data.
Declaration
[Browsable(true)]
public RelationBindingCollection RelationBindings { get; }
Property Value
ScrollBehavior
Gets the ScrollServiceBehavior that is responsible for the kinetic scrolling option.
Declaration
public ScrollServiceBehavior ScrollBehavior { get; }
Property Value
SelectedNode
Gets or sets the selected node.
Declaration
public virtual RadTreeNode SelectedNode { get; set; }
Property Value
The selected node.
SelectedNodes
Gets the selected nodes.
Declaration
public virtual SelectedTreeNodeCollection SelectedNodes { get; }
Property Value
The selected nodes.
ShowExpandCollapse
Gets or sets a value indicating whether [show expander].
Declaration
public bool ShowExpandCollapse { get; set; }
Property Value
true if [show expander]; otherwise, false.
ShowLines
Gets or sets a value indicating whether [show lines].
Declaration
public bool ShowLines { get; set; }
Property Value
true if [show lines]; otherwise, false.
ShowNodeToolTips
Gets or sets a value indicating whether [show node tool tips].
Declaration
public bool ShowNodeToolTips { get; set; }
Property Value
true if [show node tool tips]; otherwise, false.
ShowRootLines
Gets or sets a value indicating whether [show root lines].
Declaration
public bool ShowRootLines { get; set; }
Property Value
true if [show root lines]; otherwise, false.
SortDescriptors
Gets the sort descriptors.
Declaration
[Browsable(false)]
public SortDescriptorCollection SortDescriptors { get; }
Property Value
The sort descriptors.
SortOrder
Gets or sets the sort order of Nodes.
Declaration
[Browsable(false)]
public SortOrder SortOrder { get; set; }
Property Value
The sort order.
ToggleMode
Gets or sets the toggle mode.
Declaration
[Browsable(false)]
public ToggleMode ToggleMode { get; set; }
Property Value
The toggle mode.
ToggleStateConverter
Gets or sets a 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
TopNode
Gets the first visible tree node in the tree view.
TreeIndent
Gets or sets the indent of nodes, applied to each tree level.
TreeNodeProvider
Gets or sets the tree node provider.
Declaration
public virtual TreeNodeProvider TreeNodeProvider { get; set; }
Property Value
The tree node provider.
TriStateMode
Gets or sets a value indicating whether [tri state mode].
Declaration
[Browsable(false)]
public virtual bool TriStateMode { get; set; }
Property Value
true if [tri state mode]; otherwise, false.
ValueMember
Gets or sets a property name which will be used to extract a value from the data items. The value of the property with this name will be available via the Value property of every RadTreeNode.
VerticalScrollState
Gets or sets a property that controls the visibility of the vertical scrollbar.
Declaration
[Browsable(true)]
public ScrollState VerticalScrollState { get; set; }
Property Value
VisibleCount
Gets the number of tree nodes that are visible in the tree view
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
path
Where the node should be added.
Returns
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
path
Where the node should be added.
pathSeparator
The path separator.
Returns
The new node if the operation is successful.
AutoExpand(RadTreeNode)
Declaration
protected virtual void AutoExpand(RadTreeNode node)
Parameters
node
AutoScrollOnDragging(TreeNodeElement)
Declaration
protected virtual bool AutoScrollOnDragging(TreeNodeElement hitItem)
Parameters
hitItem
Returns
BeginEdit()
Puts the current node in edit mode.
BeginInit()
Declaration
public void BeginInit()
BringIntoView(RadTreeNode)
Ensures that the specified tree node is visible within the tree view element, scrolling the contents of the element if necessary. This method expands parent items when necessary.
Declaration
public void BringIntoView(RadTreeNode node)
Parameters
node
The node to bring into view
CancelEdit()
Close the currently active editor and discard changes.
Declaration
public void CancelEdit()
ClearSelection()
Declaration
public virtual void ClearSelection()
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateDragDropService()
Declaration
protected virtual TreeViewDragDropService CreateDragDropService()
Returns
CreateElementProvider()
This method creates an object that implements IVirtualizedElementProvider. Child elements are not yet created in this method.
Declaration
protected override IVirtualizedElementProvider<RadTreeNode> CreateElementProvider()
Returns
IVirtualizedElementProvider<RadTreeNode>
A new instance of an implementation of IVirtualizedElementProvider.
Overrides
CreateExpandAnimation()
Declaration
protected virtual TreeExpandAnimation CreateExpandAnimation()
Returns
CreateNewNode(string)
Declaration
protected virtual RadTreeNode CreateNewNode(string defaultText)
Parameters
defaultText
Returns
CreateViewElement()
Creates the view element.
Declaration
protected override VirtualizedStackContainer<RadTreeNode> CreateViewElement()
Returns
Overrides
DeferRefresh()
Defers the refresh.
DisposeManagedResources()
Disposes of managed resources including cached images and SVG images when the element is being disposed.
Declaration
protected override void DisposeManagedResources()
Overrides
DpiScaleChanged(SizeF)
Called when the DPI scale factor changes. Updates the scale factor and notifies child elements.
Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
scaleFactor
The new DPI scale factor.
Overrides
EndEdit()
Commits any changes and ends the edit operation on the current cell.
EndInit()
Declaration
public virtual void EndInit()
EndUpdate(bool, UpdateActions)
Ends the update.
Declaration
public void EndUpdate(bool performUpdate, RadTreeViewElement.UpdateActions action)
Parameters
performUpdate
Tells the view whether an update is required or not.
action
RadTreeViewElement.UpdateActions
Indicates the update action
EnsureNodeVisibleHorizontal(RadTreeNode, TreeNodeElement)
Declaration
protected virtual void EnsureNodeVisibleHorizontal(RadTreeNode node, TreeNodeElement nodeElement)
Parameters
node
nodeElement
EnsureNodeVisibleVertical(RadTreeNode, TreeNodeElement)
Declaration
protected virtual TreeNodeElement EnsureNodeVisibleVertical(RadTreeNode node, TreeNodeElement nodeElement)
Parameters
node
nodeElement
Returns
EnsureNodeVisibleVerticalCore(RadTreeNode)
Declaration
protected virtual TreeNodeElement EnsureNodeVisibleVerticalCore(RadTreeNode node)
Parameters
node
Returns
EnsureVisible(RadTreeNode)
Ensures that the specified tree node is visible within the tree view element, scrolling the contents of the element if necessary.
Declaration
public virtual void EnsureVisible(RadTreeNode node)
Parameters
node
The node to scroll into view
Execute(ICommand, params object[])
Executes the specified command.
Execute(bool, ICommand, params object[])
Executes the specified command include sub trees.
Find(Predicate<RadTreeNode>)
Finds the specified match.
Declaration
public RadTreeNode Find(Predicate<RadTreeNode> match)
Parameters
match
The match.
Returns
Find(string)
Finds the specified text.
Declaration
public virtual RadTreeNode Find(string text)
Parameters
text
The text.
Returns
Find<T>(FindAction<T>, T)
Declaration
public RadTreeNode Find<T>(FindAction<T> match, T arg)
Parameters
match
FindAction<T>
arg
T
Returns
FindNodes(Predicate<RadTreeNode>)
Finds the nodes.
Declaration
public RadTreeNode[] FindNodes(Predicate<RadTreeNode> match)
Parameters
match
The match.
Returns
FindNodes(string)
Finds the nodes.
Declaration
public virtual RadTreeNode[] FindNodes(string text)
Parameters
text
The text.
Returns
FindNodes<T>(FindAction<T>, T)
Finds the nodes.
Declaration
public RadTreeNode[] FindNodes<T>(FindAction<T> match, T arg)
Parameters
match
FindAction<T>
The match.
arg
T
The argument.
Returns
ForEach(Action<RadTreeNode>)
Execute the specified action for every RadTreeNode in the tree
Declaration
public void ForEach(Action<RadTreeNode> action)
Parameters
action
GetDescendantNodes(RadTreeNode)
Gets an enumerator which enumerates all descendant nodes of a node.
Declaration
public IEnumerable<RadTreeNode> GetDescendantNodes(RadTreeNode current)
Parameters
current
Returns
IEnumerable<RadTreeNode>
The enumerator.
GetEditor(Type)
Declaration
protected virtual IInputEditor GetEditor(Type editorType)
Parameters
editorType
Returns
GetFirstMatch(string, RadTreeNodeCollection)
This method traverses through the visible nodes of RadTreeView and returns a node that matches the searchCriteria.
Declaration
protected virtual RadTreeNode GetFirstMatch(string searchCriteria, RadTreeNodeCollection nodes)
Parameters
searchCriteria
nodes
Returns
GetNodeAt(Point)
Gets the node at.
Declaration
public RadTreeNode GetNodeAt(Point pt)
Parameters
pt
The pt.
Returns
GetNodeAt(int, int)
Gets the node at.
Declaration
public RadTreeNode GetNodeAt(int x, int y)
Parameters
x
The x.
y
The y.
Returns
GetNodeByName(string)
Gets a node with the specified name.
Declaration
public RadTreeNode GetNodeByName(string name)
Parameters
name
The name of the node.
Returns
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
name
The name of the node.
rootNode
The node which the should be taken as a root.
Returns
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
path
The path to the node.
Returns
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
path
The path to the node.
pathSeparator
The path separator.
Returns
The node if found.
GetNodeCount(bool)
Gets the node count.
GetNodeElementAt(Point)
Gets the node element at.
Declaration
public TreeNodeElement GetNodeElementAt(Point pt)
Parameters
pt
The pt.
Returns
GetNodeElementAt(int, int)
Gets the node element at.
Declaration
public TreeNodeElement GetNodeElementAt(int x, int y)
Parameters
x
The x.
y
The y.
Returns
GetNodes()
Gets an enumerator which enumerates all nodes in the tree.
Declaration
public IEnumerable<RadTreeNode> GetNodes()
Returns
IEnumerable<RadTreeNode>
The enumerator.
InitializeDefaultContextMenu(RadTreeNode)
Declaration
protected virtual RadContextMenu InitializeDefaultContextMenu(RadTreeNode node)
Parameters
node
Returns
InitializeFields()
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
Declaration
protected override void InitializeFields()
Overrides
OnAutoSizeChanged()
Called when auto size is changed.
Declaration
protected override void OnAutoSizeChanged()
Overrides
OnBindingContextChanged(EventArgs)
Declaration
protected virtual void OnBindingContextChanged(EventArgs e)
Parameters
e
OnContextMenuOpening(TreeViewContextMenuOpeningEventArgs)
Declaration
protected virtual void OnContextMenuOpening(TreeViewContextMenuOpeningEventArgs e)
Parameters
e
OnCreateNode(CreateTreeNodeEventArgs)
Declaration
protected virtual void OnCreateNode(CreateTreeNodeEventArgs e)
Parameters
e
OnCreateNodeElement(CreateTreeNodeElementEventArgs)
Declaration
protected virtual void OnCreateNodeElement(CreateTreeNodeElementEventArgs e)
Parameters
e
OnDataError(TreeNodeDataErrorEventArgs)
Raises the event.
Declaration
protected virtual void OnDataError(TreeNodeDataErrorEventArgs e)
Parameters
e
The TreeNodeDataErrorEventArgs instance containing the event data.
OnDragEnded(RadTreeViewDragEventArgs)
Declaration
protected virtual void OnDragEnded(RadTreeViewDragEventArgs e)
Parameters
e
OnDragEnding(RadTreeViewDragCancelEventArgs)
Declaration
protected virtual void OnDragEnding(RadTreeViewDragCancelEventArgs e)
Parameters
e
OnDragOverNode(RadTreeViewDragCancelEventArgs)
Declaration
protected virtual void OnDragOverNode(RadTreeViewDragCancelEventArgs e)
Parameters
e
OnDragStarted(RadTreeViewDragEventArgs)
Declaration
protected virtual void OnDragStarted(RadTreeViewDragEventArgs e)
Parameters
e
OnDragStarting(RadTreeViewDragCancelEventArgs)
Declaration
protected virtual void OnDragStarting(RadTreeViewDragCancelEventArgs e)
Parameters
e
OnEdited(TreeNodeEditedEventArgs)
Declaration
protected virtual void OnEdited(TreeNodeEditedEventArgs e)
Parameters
e
OnEditing(TreeNodeEditingEventArgs)
Declaration
protected virtual void OnEditing(TreeNodeEditingEventArgs e)
Parameters
e
OnEditing(object, TreeNodeEditingEventArgs)
Declaration
protected virtual void OnEditing(object sender, TreeNodeEditingEventArgs e)
Parameters
sender
e
OnEditorInitialized(TreeNodeEditorInitializedEventArgs)
Declaration
protected virtual void OnEditorInitialized(TreeNodeEditorInitializedEventArgs e)
Parameters
e
OnEditorRequired(TreeNodeEditorRequiredEventArgs)
Declaration
protected virtual void OnEditorRequired(TreeNodeEditorRequiredEventArgs e)
Parameters
e
OnEditorRequired(object, TreeNodeEditorRequiredEventArgs)
Declaration
protected virtual void OnEditorRequired(object sender, TreeNodeEditorRequiredEventArgs e)
Parameters
sender
e
OnItemDrag(RadTreeViewEventArgs)
Declaration
protected virtual void OnItemDrag(RadTreeViewEventArgs e)
Parameters
e
OnLoaded()
Called when the element has been successfully loaded. That includes loading of all its children as well.
Declaration
protected override void OnLoaded()
Overrides
OnNodeAdded(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeAdded(RadTreeViewEventArgs e)
Parameters
e
OnNodeAdding(RadTreeViewCancelEventArgs)
Declaration
protected virtual void OnNodeAdding(RadTreeViewCancelEventArgs e)
Parameters
e
OnNodeCheckedChanged(RadTreeNode)
Declaration
protected void OnNodeCheckedChanged(RadTreeNode node)
Parameters
node
OnNodeCheckedChanged(RadTreeNode, CheckedMode)
Declaration
protected void OnNodeCheckedChanged(RadTreeNode node, CheckedMode checkedMode)
Parameters
node
checkedMode
OnNodeCheckedChanged(TreeNodeCheckedEventArgs)
Declaration
protected virtual void OnNodeCheckedChanged(TreeNodeCheckedEventArgs e)
Parameters
e
OnNodeCheckedChanging(RadTreeNode)
Declaration
protected bool OnNodeCheckedChanging(RadTreeNode node)
Parameters
node
Returns
OnNodeCheckedChanging(RadTreeViewCancelEventArgs)
Declaration
protected virtual void OnNodeCheckedChanging(RadTreeViewCancelEventArgs e)
Parameters
e
OnNodeDataBound(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeDataBound(RadTreeViewEventArgs e)
Parameters
e
OnNodeExpandedChanged(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeExpandedChanged(RadTreeViewEventArgs e)
Parameters
e
OnNodeExpandedChanging(RadTreeNode)
Declaration
protected bool OnNodeExpandedChanging(RadTreeNode node)
Parameters
node
Returns
OnNodeExpandedChanging(RadTreeViewCancelEventArgs)
Declaration
protected virtual void OnNodeExpandedChanging(RadTreeViewCancelEventArgs e)
Parameters
e
OnNodeFormatting(TreeNodeFormattingEventArgs)
Declaration
protected virtual void OnNodeFormatting(TreeNodeFormattingEventArgs e)
Parameters
e
OnNodeMouseClick(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeMouseClick(RadTreeViewEventArgs e)
Parameters
e
OnNodeMouseDoubleClick(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeMouseDoubleClick(RadTreeViewEventArgs e)
Parameters
e
OnNodeMouseDown(RadTreeViewMouseEventArgs)
Declaration
protected virtual void OnNodeMouseDown(RadTreeViewMouseEventArgs e)
Parameters
e
OnNodeMouseEnter(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeMouseEnter(RadTreeViewEventArgs e)
Parameters
e
OnNodeMouseHover(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeMouseHover(RadTreeViewEventArgs e)
Parameters
e
OnNodeMouseLeave(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeMouseLeave(RadTreeViewEventArgs e)
Parameters
e
OnNodeMouseMove(RadTreeViewMouseEventArgs)
Declaration
protected virtual void OnNodeMouseMove(RadTreeViewMouseEventArgs e)
Parameters
e
OnNodeMouseUp(RadTreeViewMouseEventArgs)
Declaration
protected virtual void OnNodeMouseUp(RadTreeViewMouseEventArgs e)
Parameters
e
OnNodeRemoved(RadTreeViewEventArgs)
Declaration
protected virtual void OnNodeRemoved(RadTreeViewEventArgs e)
Parameters
e
OnNodeRemoving(RadTreeViewCancelEventArgs)
Declaration
protected virtual void OnNodeRemoving(RadTreeViewCancelEventArgs e)
Parameters
e
OnNodesNeeded(NodesNeededEventArgs)
Declaration
protected virtual bool OnNodesNeeded(NodesNeededEventArgs e)
Parameters
e
Returns
OnNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the standard .NET PropertyChanged event to notify subscribers of property value changes using the provided event arguments.
Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
e
The PropertyChangedEventArgs containing the property change information.
Overrides
OnPanGesture(PanGestureEventArgs)
Fires the PanGesture event.
Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
args
The arguments for the PanGesture event.
Overrides
OnPropertyChanged(RadPropertyChangedEventArgs)
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
Event arguments containing information about the property that changed.
Overrides
OnSelectedNodeChanged(RadTreeViewEventArgs)
Declaration
protected virtual void OnSelectedNodeChanged(RadTreeViewEventArgs args)
Parameters
args
OnSelectedNodeChanging(RadTreeViewCancelEventArgs)
Declaration
protected virtual void OnSelectedNodeChanging(RadTreeViewCancelEventArgs args)
Parameters
args
OnSelectedNodesChanged(RadTreeNode)
Declaration
protected virtual void OnSelectedNodesChanged(RadTreeNode node)
Parameters
node
OnSelectedNodesCleared()
Declaration
protected virtual void OnSelectedNodesCleared()
OnShowExpander(TreeViewShowExpanderEventArgs)
Declaration
protected virtual void OnShowExpander(TreeViewShowExpanderEventArgs e)
Parameters
e
OnStyleChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnStyleChanged(RadPropertyChangedEventArgs e)
Parameters
e
Overrides
OnValidationError(EventArgs)
Declaration
protected virtual void OnValidationError(EventArgs e)
Parameters
e
OnValueChanged(TreeNodeValueChangedEventArgs)
Declaration
protected virtual void OnValueChanged(TreeNodeValueChangedEventArgs e)
Parameters
e
OnValueChanging(TreeNodeValueChangingEventArgs)
Declaration
protected virtual void OnValueChanging(TreeNodeValueChangingEventArgs e)
Parameters
e
OnValueValidating(TreeNodeValidatingEventArgs)
Declaration
protected virtual void OnValueValidating(TreeNodeValidatingEventArgs e)
Parameters
e
PassesFilter(RadTreeNode)
Declaration
protected virtual bool PassesFilter(RadTreeNode node)
Parameters
node
Returns
ProcessKeyDown(KeyEventArgs)
Declaration
protected virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters
e
Returns
ProcessKeyPress(KeyPressEventArgs)
Declaration
protected virtual bool ProcessKeyPress(KeyPressEventArgs e)
Parameters
e
Returns
ProcessMouseClick(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseClick(MouseEventArgs e)
Parameters
e
Returns
ProcessMouseDoubleClick(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseDoubleClick(MouseEventArgs e)
Parameters
e
Returns
ProcessMouseDown(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseDown(MouseEventArgs e)
Parameters
e
Returns
ProcessMouseMove(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseMove(MouseEventArgs e)
Parameters
e
Returns
ProcessMouseUp(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseUp(MouseEventArgs e)
Parameters
e
Returns
ProcessMouseWheel(MouseEventArgs)
Declaration
protected virtual bool ProcessMouseWheel(MouseEventArgs e)
Parameters
e
Returns
ResumeProvider()
Declaration
protected void ResumeProvider()
SaveEditorValue(TreeNodeElement, object)
Declaration
protected virtual void SaveEditorValue(TreeNodeElement nodeElement, object newValue)
Parameters
nodeElement
newValue
ScrollTo(int)
Scrolls to.
SelectAll()
Declaration
public virtual void SelectAll()
SetError(string, RadTreeNode, params object[])
Sets the error.
Declaration
public void SetError(string text, RadTreeNode radTreeNode, params object[] context)
Parameters
text
The text.
radTreeNode
The RAD tree node.
context
object[]
The context where this error occurred.
SuspendProvider()
Declaration
protected void SuspendProvider()
SynchronizeNodeElements()
Declaration
protected virtual void SynchronizeNodeElements()
Update(UpdateActions)
Updates the visual items in the three view
Declaration
public void Update(RadTreeViewElement.UpdateActions updateAction)
Parameters
updateAction
RadTreeViewElement.UpdateActions
Indicated the update action
Update(UpdateActions, params RadTreeNode[])
Updates the visual items in the three view
Declaration
public void Update(RadTreeViewElement.UpdateActions updateAction, params RadTreeNode[] nodes)
Parameters
updateAction
RadTreeViewElement.UpdateActions
Indicated the update action
nodes
Array representing the nodes which should be updated
UpdateActualSize(RadTreeNode, bool, RadTreeNode)
Declaration
protected virtual void UpdateActualSize(RadTreeNode node, bool stopOnSameLevel, RadTreeNode skipNode)
Parameters
node
stopOnSameLevel
skipNode
UpdateFitToSizeMode()
Updates the items fit to size mode.
Declaration
protected override void UpdateFitToSizeMode()
Overrides
UpdateHScrollbarVisibility()
Declaration
protected virtual void UpdateHScrollbarVisibility()
UpdateOnExpandedChanged(UpdateActions, RadTreeNode)
Declaration
protected virtual bool UpdateOnExpandedChanged(RadTreeViewElement.UpdateActions updateAction, RadTreeNode node)
Parameters
updateAction
RadTreeViewElement.UpdateActions
node
Returns
UpdateOnExpandedChangedCore(RadTreeNode)
Declaration
protected virtual void UpdateOnExpandedChangedCore(RadTreeNode node)
Parameters
node
UpdateOnMeasure(SizeF)
Updates on measure.
UpdateScrollers(RadTreeNode, UpdateActions)
Declaration
protected virtual void UpdateScrollers(RadTreeNode skipNode, RadTreeViewElement.UpdateActions updateAction)
Parameters
skipNode
updateAction
UpdateScrollersOnAdd(RadTreeNode)
Declaration
protected virtual void UpdateScrollersOnAdd(RadTreeNode node)
Parameters
node
UpdateScrollersOnCollapse(RadTreeNode)
Declaration
protected virtual void UpdateScrollersOnCollapse(RadTreeNode node)
Parameters
node
UpdateScrollersOnExpand(RadTreeNode)
Declaration
protected virtual void UpdateScrollersOnExpand(RadTreeNode node)
Parameters
node
UpdateScrollersOnNodesNeeded(RadTreeNode)
Declaration
protected virtual void UpdateScrollersOnNodesNeeded(RadTreeNode node)
Parameters
node
Events
BindingContextChanged
Occurs when [binding context changed].
Declaration
public event EventHandler BindingContextChanged
Event Value
Implements
ContextMenuOpening
Declaration
public event TreeViewContextMenuOpeningEventHandler ContextMenuOpening
Event Value
CreateNode
Occurs when RadTreeNode is created.
Declaration
public event CreateTreeNodeEventHandler CreateNode
Event Value
CreateNodeElement
Occurs when TreeNodeElement is created.
Declaration
public event CreateTreeNodeElementEventHandler CreateNodeElement
Event Value
DataError
Occurs when [data error].
Declaration
public event TreeNodeDataErrorEventHandler DataError
Event Value
DragEnded
Occurs when a drag has ended
Declaration
public event RadTreeView.DragEndedHandler DragEnded
Event Value
DragEnding
Occurs when a drag is ending
Declaration
public event RadTreeView.DragEndingHandler DragEnding
Event Value
DragOverNode
Occurs when drag feedback is needed for a node.
Declaration
public event EventHandler<RadTreeViewDragCancelEventArgs> DragOverNode
Event Value
DragStarted
Occurs when a drag has started
Declaration
public event RadTreeView.DragStartedHandler DragStarted
Event Value
DragStarting
Occurs when a drag is starting
Declaration
public event RadTreeView.DragStartingHandler DragStarting
Event Value
Edited
Occurs when editing has been finished.
Declaration
public event TreeNodeEditedEventHandler Edited
Event Value
Editing
Occurs when editing is started.
Declaration
public event TreeNodeEditingEventHandler Editing
Event Value
EditorInitialized
Occurs when editor is initialized.
Declaration
public event TreeNodeEditorInitializedEventHandler EditorInitialized
Event Value
EditorRequired
Occurs when editor is required.
Declaration
public event RadTreeView.EditorRequiredHandler EditorRequired
Event Value
ItemDrag
Occurs when the user begins dragging an item.
Declaration
public event RadTreeView.ItemDragHandler ItemDrag
Event Value
NodeAdded
Occurs after a node is being added.
Declaration
public event RadTreeView.RadTreeViewEventHandler NodeAdded
Event Value
NodeAdding
Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeAdding
Event Value
NodeCheckedChanged
Occurs when node's checked state is changed.
Declaration
public virtual event TreeNodeCheckedEventHandler NodeCheckedChanged
Event Value
NodeCheckedChanging
Occurs when node's checked state is changing.
Declaration
public virtual event RadTreeView.RadTreeViewCancelEventHandler NodeCheckedChanging
Event Value
NodeDataBound
Occurs after a node is bound to a data item.
Declaration
public event RadTreeView.RadTreeViewEventHandler NodeDataBound
Event Value
NodeExpandedChanged
Occurs when node has been expanded.
Declaration
public event RadTreeView.TreeViewEventHandler NodeExpandedChanged
Event Value
NodeExpandedChanging
Occurs when node is expanding.
Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeExpandedChanging
Event Value
NodeFormatting
Occurs when TreeNodeElement is formatting
Declaration
public event TreeNodeFormattingEventHandler NodeFormatting
Event Value
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 MouseEventArgs.
Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseClick
Event Value
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 MouseEventArgs.
Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseDoubleClick
Event Value
NodeMouseDown
Occurs when TreeNodeElement is mouse down.
Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseDown
Event Value
NodeMouseEnter
Occurs when mouse enters a TreeNodeElement
Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseEnter
Event Value
NodeMouseHover
Occurs when TreeNodeElement is hovered.
Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseHover
Event Value
NodeMouseLeave
Occurs when mouse leaves a TreeNodeElement
Declaration
public event RadTreeView.TreeViewEventHandler NodeMouseLeave
Event Value
NodeMouseMove
Occurs when mouse is move over a TreeNodeElement.
Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseMove
Event Value
NodeMouseUp
Occurs when TreeNodeElement is mouse up.
Declaration
public event RadTreeView.TreeViewMouseEventHandler NodeMouseUp
Event Value
NodeRemoved
Occurs after a node is removed.
Declaration
public event RadTreeView.RadTreeViewEventHandler NodeRemoved
Event Value
NodeRemoving
Declaration
public event RadTreeView.RadTreeViewCancelEventHandler NodeRemoving
Event Value
NodesNeeded
Occurs when nodes are needed in load on demand hierarchy
Declaration
public event NodesNeededEventHandler NodesNeeded
Event Value
SelectedNodeChanged
Occurs when selected node has been changed.
Declaration
public virtual event RadTreeView.RadTreeViewEventHandler SelectedNodeChanged
Event Value
SelectedNodeChanging
Occurs when the selected node is changing
Declaration
public virtual event RadTreeView.RadTreeViewCancelEventHandler SelectedNodeChanging
Event Value
SelectedNodesChanged
Occurs when SelectedNodes collection has been changed.
Declaration
public virtual event EventHandler<RadTreeViewEventArgs> SelectedNodesChanged
Event Value
SelectedNodesCleared
Occurs when selected node has been cleared.
Declaration
public virtual event EventHandler SelectedNodesCleared
Event Value
ShowExpander
Occurs when LazyMode is true and NodesNeeded event is handled
Declaration
public event RadTreeView.TreeViewShowExpanderEventHandler ShowExpander
Event Value
ValidationError
Occurs when validation error occurs by canceling the ValueValidating event.
ValueChanged
Occurs when node's value has been changed.
Declaration
public event TreeNodeValueChangedEventHandler ValueChanged
Event Value
ValueChanging
Occurs when node's value is changing.
Declaration
public event TreeNodeValueChangingEventHandler ValueChanging
Event Value
ValueValidating
Occurs when node's value is validating.
Declaration
public event TreeNodeValidatingEventHandler ValueValidating
Event Value