• Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop
    Web
    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for ASP.NET AJAX UI for ASP.NET MVC UI for ASP.NET Core UI for Blazor UI for Silverlight UI for PHP UI for JSP
    Mobile
    UI for .NET MAUI UI for Xamarin
    Document Management
    Telerik Document Processing
    Desktop
    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF UI for UWP
    Reporting & Mocking
    Telerik Reporting Telerik Report Server Telerik JustMock
    Automated Testing
    Test Studio Test Studio Dev Edition
    CMS
    Sitefinity
    UI/UX Design
    Unite UX
    Debugging
    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Jam FiddlerCap FiddlerCore
    Extended Reality
    UI for Unity XR
    Free Tools
    JustAssembly JustDecompile VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Release History
  • Docs & Support
  • Pricing
  • Search
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class RadTreeViewItem

Represents an item in the RadTreeView control.

Inheritance
System.Object
ItemsControl
HeaderedItemsControl
EditableHeaderedItemsControl
RadTreeViewItem
RadPanelBarItem
Inherited Members
EditableHeaderedItemsControl.EditedEvent
EditableHeaderedItemsControl.EditCanceledEvent
EditableHeaderedItemsControl.PreviewEditCanceledEvent
EditableHeaderedItemsControl.PreviewEditedEvent
EditableHeaderedItemsControl.PreviewEditStartedEvent
EditableHeaderedItemsControl.EditStartedEvent
EditableHeaderedItemsControl.PreviewEditorPrepareEvent
EditableHeaderedItemsControl.EditorPrepareEvent
EditableHeaderedItemsControl.IsInEditModeProperty
EditableHeaderedItemsControl.HeaderEditTemplateSelectorProperty
EditableHeaderedItemsControl.HeaderEditTemplateProperty
EditableHeaderedItemsControl.IsEditableProperty
EditableHeaderedItemsControl.add_EditStarted(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_EditStarted(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_PreviewEdited(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_PreviewEdited(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_EditCanceled(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_EditCanceled(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_Edited(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_Edited(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_PreviewEditStarted(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.add_PreviewEditorPrepare(EditorPrepareEventHandler)
EditableHeaderedItemsControl.remove_PreviewEditorPrepare(EditorPrepareEventHandler)
EditableHeaderedItemsControl.add_EditorPrepare(EditorPrepareEventHandler)
EditableHeaderedItemsControl.remove_EditorPrepare(EditorPrepareEventHandler)
EditableHeaderedItemsControl.AddEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.RemoveEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.AddEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.RemoveEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.AddEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.RemoveEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.AddPreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.RemovePreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.AddPreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.RemovePreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
EditableHeaderedItemsControl.AddPreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
EditableHeaderedItemsControl.RemovePreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
EditableHeaderedItemsControl.AddEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
EditableHeaderedItemsControl.RemoveEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
EditableHeaderedItemsControl.PrepareEditor(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnEditorPrepare(EditorPrepareEventArgs)
EditableHeaderedItemsControl.GetEditValue()
EditableHeaderedItemsControl.SetEditValue(Object)
EditableHeaderedItemsControl.OnPreviewEdited(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnEdited(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnEditCanceled(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnPreviewEditCanceled(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnEditStarted(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnPreviewEditStarted(RadTreeViewItemEditedEventArgs)
EditableHeaderedItemsControl.OnHeaderEditTemplateChanged(DataTemplate, DataTemplate)
EditableHeaderedItemsControl.OnHeaderEditTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)
EditableHeaderedItemsControl.IsInEditMode
EditableHeaderedItemsControl.HeaderEditTemplate
EditableHeaderedItemsControl.HeaderEditTemplateSelector
EditableHeaderedItemsControl.IsEditable
EditableHeaderedItemsControl.HeaderEditPresenterElement
EditableHeaderedItemsControl.EditStarted
EditableHeaderedItemsControl.PreviewEdited
EditableHeaderedItemsControl.EditCanceled
EditableHeaderedItemsControl.PreviewEditCanceled
EditableHeaderedItemsControl.Edited
EditableHeaderedItemsControl.PreviewEditStarted
EditableHeaderedItemsControl.PreviewEditorPrepare
EditableHeaderedItemsControl.EditorPrepare
HeaderedItemsControl.HasHeaderProperty
HeaderedItemsControl.HeaderProperty
HeaderedItemsControl.FocusVisualStyleProperty
HeaderedItemsControl.HeaderTemplateProperty
HeaderedItemsControl.HeaderTemplateSelectorProperty
HeaderedItemsControl.OnHeaderTemplateChanged(DataTemplate, DataTemplate)
HeaderedItemsControl.OnHeaderTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)
HeaderedItemsControl.HasHeader
HeaderedItemsControl.Header
HeaderedItemsControl.HeaderTemplate
HeaderedItemsControl.FocusVisualStyle
HeaderedItemsControl.HeaderTemplateSelector
ItemsControl.ItemContainerStyleProperty
ItemsControl.IsTextSearchEnabledProperty
ItemsControl.ItemContainerStyleSelectorProperty
ItemsControl.ItemTemplateSelectorProperty
ItemsControl.IsFocusedProperty
ItemsControl.HasItemsProperty
ItemsControl.ItemsControlFromItemContainer(DependencyObject)
ItemsControl.ChangeVisualState()
ItemsControl.OnItemTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)
ItemsControl.OnIsFocusedChanged(DependencyPropertyChangedEventArgs)
ItemsControl.IsTextSearchEnabled
ItemsControl.HasItems
ItemsControl.IsFocused
ItemsControl.ItemContainerStyle
ItemsControl.ItemContainerStyleSelector
ItemsControl.ItemTemplateSelector
ItemsControl.OverrideStyles
ItemsControl.ItemContainerGenerator
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadTreeViewItem : EditableHeaderedItemsControl, TreeViewPanel.IProvideStackingSize, TreeViewPanel.ICachable, ICommandSource
Remarks

The RadTreeView control is made up of items. Items which are immediate children of the TreeView are root items. Items which are children of root items are child items.

An item usually stores data in two properties, the Header property and the Tag property. The value of the Header property is displayed in the RadTreeView control, and the Tag property is used to store additional data.

To create tree items, use one of the following methods:

Constructors

RadTreeViewItem()

Initializes a new instance of the RadTreeViewItem class.

Declaration
public RadTreeViewItem()

Fields

CheckedEvent

Identifies the Checked routed event.

Declaration
public static readonly RoutedEvent CheckedEvent
Field Value
RoutedEvent

CheckStateProperty

Identifies the CheckState dependency property.

Declaration
public static readonly DependencyProperty CheckStateProperty
Field Value
System.Windows.DependencyProperty

ClickEvent

Identifies the Click routed event.

Declaration
public static readonly RoutedEvent ClickEvent
Field Value
RoutedEvent

CollapsedEvent

Identifies the Collapsed routed event.

Declaration
public static readonly RoutedEvent CollapsedEvent
Field Value
RoutedEvent

CommandExecutionTriggerProperty

Identifies the CommandExecutionTrigger dependency property.

Declaration
public static readonly DependencyProperty CommandExecutionTriggerProperty
Field Value
System.Windows.DependencyProperty

CommandParameterProperty

Identifies the CommandParameter dependency property.

Declaration
public static readonly DependencyProperty CommandParameterProperty
Field Value
System.Windows.DependencyProperty

CommandProperty

Identifies the ClickCommand dependency property.

Declaration
public static readonly DependencyProperty CommandProperty
Field Value
System.Windows.DependencyProperty

CommandTargetProperty

Identifies the CommandTarget dependency property.

Declaration
public static readonly DependencyProperty CommandTargetProperty
Field Value
System.Windows.DependencyProperty

DefaultImageSrcProperty

Identifies the DefaultImageSrc dependency property.

Declaration
public static readonly DependencyProperty DefaultImageSrcProperty
Field Value
System.Windows.DependencyProperty

DoubleClickEvent

Identifies the DoubleClick routed event.

Declaration
public static readonly RoutedEvent DoubleClickEvent
Field Value
RoutedEvent

DropPositionProperty

Identifies the DropPosition property.

Declaration
public static readonly DependencyProperty DropPositionProperty
Field Value
System.Windows.DependencyProperty

ExpandedEvent

Identifies the Expanded routed event.

Declaration
public static readonly RoutedEvent ExpandedEvent
Field Value
RoutedEvent

ExpandedImageSrcProperty

Identifies the ExpandedImageSrc dependency property.

Declaration
public static readonly DependencyProperty ExpandedImageSrcProperty
Field Value
System.Windows.DependencyProperty

ExpanderButtonMinWidthProperty

Identifies the ExpanderButtonMinWidth dependency property.

Declaration
public static readonly DependencyProperty ExpanderButtonMinWidthProperty
Field Value
System.Windows.DependencyProperty

ExpanderStyleProperty

Identifies the ExpanderStyle dependency property.

Declaration
public static readonly DependencyProperty ExpanderStyleProperty
Field Value
System.Windows.DependencyProperty

IsCheckBoxEnabledProperty

Identifies the IsCheckBoxEnabled dependency property.

Declaration
public static readonly DependencyProperty IsCheckBoxEnabledProperty
Field Value
System.Windows.DependencyProperty

IsCheckedProperty

Identifies the IsChecked property.

Declaration
public static readonly DependencyProperty IsCheckedProperty
Field Value
System.Windows.DependencyProperty

IsDragOverProperty

Identifies the IsDragOver property.

Declaration
public static readonly DependencyProperty IsDragOverProperty
Field Value
System.Windows.DependencyProperty

IsDropAllowedProperty

Identifies the IsDropAllowed dependency property.

Declaration
public static readonly DependencyProperty IsDropAllowedProperty
Field Value
System.Windows.DependencyProperty

IsExpandedProperty

Identifies the IsExpanded dependency property.

Declaration
public static readonly DependencyProperty IsExpandedProperty
Field Value
System.Windows.DependencyProperty

IsLoadingOnDemandProperty

Identifies the IsLoadingOnDemand dependency property.

Declaration
public static readonly DependencyProperty IsLoadingOnDemandProperty
Field Value
System.Windows.DependencyProperty

IsLoadOnDemandEnabledProperty

Identifies the IsLoadOnDemandEnabled dependency property.

Declaration
public static readonly DependencyProperty IsLoadOnDemandEnabledProperty
Field Value
System.Windows.DependencyProperty

IsMouseOverHeaderProperty

Identifies the IsMouseOverHeader dependency property.

Declaration
public static readonly DependencyProperty IsMouseOverHeaderProperty
Field Value
System.Windows.DependencyProperty

IsMouseOverProperty

Identifies the IsMouseOver dependency property.

Declaration
public static readonly DependencyProperty IsMouseOverProperty
Field Value
System.Windows.DependencyProperty

IsSelectableProperty

Identifies the IsSelectable dependency property.

Declaration
public static readonly DependencyProperty IsSelectableProperty
Field Value
System.Windows.DependencyProperty

IsSelectedProperty

Identifies the IsSelected dependency property.

Declaration
public static readonly DependencyProperty IsSelectedProperty
Field Value
System.Windows.DependencyProperty

IsSelectionActiveProperty

Identifies the IsSelectionActive dependency property.

Declaration
public static readonly DependencyProperty IsSelectionActiveProperty
Field Value
System.Windows.DependencyProperty

IsSelectionActivePropertyKey

Identifies the IsSelectionActivePropertyKey dependency property.

Declaration
public static readonly DependencyPropertyKey IsSelectionActivePropertyKey
Field Value
DependencyPropertyKey

ItemVisibilityProperty

Identifies the ItemVisibility dependency property.

Declaration
public static readonly DependencyProperty ItemVisibilityProperty
Field Value
System.Windows.DependencyProperty

LoadOnDemandEvent

Identifies the LoadOnDemand routed event.

Declaration
public static readonly RoutedEvent LoadOnDemandEvent
Field Value
RoutedEvent

OptionTypeProperty

Identifies the OptionTypeProperty dependency property.

Declaration
public static readonly DependencyProperty OptionTypeProperty
Field Value
System.Windows.DependencyProperty

PreviewCheckedEvent

Identifies the PreviewChecked routed event.

Declaration
public static readonly RoutedEvent PreviewCheckedEvent
Field Value
RoutedEvent

PreviewCollapsedEvent

Identifies the PreviewCollapsed routed event.

Declaration
public static readonly RoutedEvent PreviewCollapsedEvent
Field Value
RoutedEvent

PreviewExpandedEvent

Identifies the PreviewExpanded routed event.

Declaration
public static readonly RoutedEvent PreviewExpandedEvent
Field Value
RoutedEvent

PreviewSelectedEvent

Identifies the PreviewSelected routed event.

Declaration
public static readonly RoutedEvent PreviewSelectedEvent
Field Value
RoutedEvent

PreviewUncheckedEvent

Identifies the PreviewUnchecked routed event.

Declaration
public static readonly RoutedEvent PreviewUncheckedEvent
Field Value
RoutedEvent

PreviewUnselectedEvent

Identifies the PreviewUnselected routed event.

Declaration
public static readonly RoutedEvent PreviewUnselectedEvent
Field Value
RoutedEvent

SelectedEvent

Identifies the Selected routed event.

Declaration
public static readonly RoutedEvent SelectedEvent
Field Value
RoutedEvent

SelectedImageSrcProperty

Identifies the SelectedImageSrc dependency property.

Declaration
public static readonly DependencyProperty SelectedImageSrcProperty
Field Value
System.Windows.DependencyProperty

UncheckedEvent

Identifies the Unchecked routed event.

Declaration
public static readonly RoutedEvent UncheckedEvent
Field Value
RoutedEvent

UnselectedEvent

Identifies the Unselected routed event.

Declaration
public static readonly RoutedEvent UnselectedEvent
Field Value
RoutedEvent

Properties

CheckState

Gets or sets the toggle state of the item - On, Off or Indeterminate.

Declaration
public ToggleState CheckState { get; set; }
Property Value
System.Windows.Automation.ToggleState

Command

Gets or sets the command for Click event of the RadTreeViewItem.

Declaration
public ICommand Command { get; set; }
Property Value
System.Windows.Input.ICommand

The command.

Implements
ICommandSource.Command

CommandExecutionTrigger

Gets or sets a value indicating when the Command must be executed.

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

CommandParameter

Gets or sets the command parameter of the RadTreeViewItem.

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

The command parameter.

Implements
ICommandSource.CommandParameter

CommandTarget

Gets or sets the command target of the RadTreeViewItem when using routed command.

Declaration
public UIElement CommandTarget { get; set; }
Property Value
System.Windows.UIElement

The command target.

Implements
ICommandSource.CommandTarget

DefaultImageSrc

Gets or sets the image that the TreeViewItem will display by default.

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

DropPosition

Gets or sets the DropPosition for the current drop (Before, Inside, After). Setting this property only makes sense in a DragDrop handler.

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

ExpandedImageSrc

Gets or sets the image that the TreeViewItem will display when it is expanded.

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

ExpanderButtonMinWidth

Gets or sets a value indicating the min width of the grid which hosts the expander button of the RadTreeViewItem.

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

ExpanderStyle

Gets or sets the style for the item's expand arrow.

Declaration
public Style ExpanderStyle { get; set; }
Property Value
System.Windows.Style

FullPath

Gets the path from the root tree item to the current tree item delimited with the PathSeparator specified by RadTreeView.

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

Index

Gets the position of the tree item in the tree item collection.

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

IsCheckBoxEnabled

Gets whether the tree item will display a check box.

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

IsChecked

Gets or sets a value indicating whether the TreeView item is checked. Null means 'indeterminate'.

Declaration
public Nullable<bool> IsChecked { get; set; }
Property Value
System.Nullable<System.Boolean>

IsDragOver

Gets or sets a value indicating whether an item is being dragged over the TreeViewItem.

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

IsDropAllowed

Gets or sets a value indicating whether the tree item can accept data that the user drags onto it.

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

IsExpanded

Gets or sets a value indicating whether the TreeViewItem is in the expanded state.

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

IsInSelectedPath

Gets a value indicating whether this item is in the selection path.

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

IsInViewport

Gets a value indicating whether the tree item is in ScrollViewer viewport.

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

IsLoadingOnDemand

Gets or sets whether the tree item is in loading on demand state.

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

Remarks

If the LoadOnDemand event is raised and there are no items to add, use IsLoadingOnDemand property and set it to false to stop the loading animation.

IsLoadOnDemandEnabled

Gets or sets a value indicating whether loading on demand is enabled.

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

Remarks

When the value is set to true the expander visual will be visible even if the item do no have children. When the expander visual is clicked, the LoadOnDemand event is raised and you can populate the node.

IsMouseOver

Gets a value indicating whether the mouse cursor is over the item.

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

IsMouseOverHeader

Gets a value indicating whether the mouse cursor is over the item header.

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

IsRootItem

Gets a value if the item is root item.

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

IsSelectable

Gets or sets a value indicating whether the tree item can be selected. It can be selected via Mouse, keyboard or by using IsSelected property. However, this property does not prevent the selection via SelectedItem or SelectedItems property of RadTreeView. These properties accept object(s) and might be evaluated when the corresponding containers are not generated yet.

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

IsSelected

Gets or sets a value indicating whether the tree item is in selected state.

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

IsSelectionActive

Gets whether the tree item selection is active - e.g. the item is selected and the TreeView is focused.

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

Item

Gets the data item associated to the RadTreeViewItem.

Declaration
public object Item { get; }
Property Value
System.Object

Remarks

Use this property to get the data item, that is associated with this RadTreeViewItem when the RadTreeView is populated using the ItemsSource property.

ItemVisibility

Gets or sets a value indicating when the item should be visible or not.

Declaration
public Visibility ItemVisibility { get; set; }
Property Value
System.Windows.Visibility

Level

Gets the zero-based depth of the tree item in the RadTreeView tree.

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

NextItem

Gets the next available item. Used for traversal of the tree view.

Declaration
public RadTreeViewItem NextItem { get; }
Property Value
RadTreeViewItem

NextSiblingItem

Gets the next sibling tree item.

Declaration
public RadTreeViewItem NextSiblingItem { get; }
Property Value
RadTreeViewItem

OptionType

Gets or sets the type of the option element that the item displays.

Declaration
public OptionListType OptionType { get; set; }
Property Value
OptionListType

ParentItem

Gets the parent tree view item of the current tree view item.

Declaration
public RadTreeViewItem ParentItem { get; }
Property Value
RadTreeViewItem

ParentTreeView

Gets the parent tree view associated with the current tree view item.

Declaration
public RadTreeView ParentTreeView { get; }
Property Value
RadTreeView

PreviousItem

Gets the previous available item. Used for traversal of the tree view.

Declaration
public RadTreeViewItem PreviousItem { get; }
Property Value
RadTreeViewItem

PreviousSiblingItem

Gets the previous sibling tree item.

Declaration
public RadTreeViewItem PreviousSiblingItem { get; }
Property Value
RadTreeViewItem

RootItem

Gets the root parent item for this instance.

Declaration
public RadTreeViewItem RootItem { get; }
Property Value
RadTreeViewItem

SelectedImageSrc

Gets or sets the image that the TreeViewItem displays when it is selected.

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

Methods

BeginEdit()

Attempts to start editing the item.

Declaration
public override bool BeginEdit()
Returns
System.Boolean

Returns true if successful, false otherwise.

Overrides
EditableHeaderedItemsControl.BeginEdit()

BringIndexIntoView(Int32)

Brings the item with the given index into view. The method will not work before the item containers have been generated.

Declaration
public void BringIndexIntoView(int index)
Parameters
System.Int32 index

The index of the item to be brought into view.

BringIntoView()

Brings the current item into view. This method must be called after the parent tree view has been loaded.

Declaration
public void BringIntoView()

BringItemIntoView(Object)

Brings the given item into view. This is not a recursive method, it will only work for immediate items. The method will not work before the item containers have been generated.

Declaration
public void BringItemIntoView(object item)
Parameters
System.Object item

The item to be brought into view.

CancelEdit()

Cancels the edit.

Declaration
public override bool CancelEdit()
Returns
System.Boolean

Overrides
EditableHeaderedItemsControl.CancelEdit()

ChangeVisualState(Boolean)

Updates the visual state of the control.

Declaration
protected override void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean useTransitions

Indicates whether transitions should be used.

Overrides
EditableHeaderedItemsControl.ChangeVisualState(Boolean)

ClearContainerForItemOverride(DependencyObject, Object)

When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

The container element.

System.Object item

The Item.

CollapseAll()

Collapses the item and its child items recursively.

Declaration
public void CollapseAll()

CommitEdit()

Tries to Commit edit.

Declaration
public override bool CommitEdit()
Returns
System.Boolean

Returns true if successful, false otherwise.

Overrides
EditableHeaderedItemsControl.CommitEdit()

Contains(RadTreeViewItem)

Checks if the item has a particular item in its collection.

Declaration
public bool Contains(RadTreeViewItem item)
Parameters
RadTreeViewItem item

The item to be searched.

Returns
System.Boolean

Boolean value indicating the item to be searched.

EnsureVisible()

Ensures that a given item is displayed.

Declaration
public void EnsureVisible()

ExpandAll()

Expands the item and its child items recursively.

Declaration
public void ExpandAll()
Remarks

If a child item is not generated it will be expanded once it is generated.

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject

IsBefore(RadTreeViewItem)

Gets a value indicating whether this item is rendered before the passed item.

Declaration
public bool IsBefore(RadTreeViewItem item)
Parameters
RadTreeViewItem item

Returns
System.Boolean

IsDropPossible(IEnumerable)

Gets whether the the collection of dragged items can be dropped on the destination item.

Declaration
public virtual bool IsDropPossible(IEnumerable draggedItems)
Parameters
System.Collections.IEnumerable draggedItems

A collection of items that the user is dragging.

Returns
System.Boolean

True if a drop is possible, false otherwise.

Remarks

The method makes sure that parents will not be dropped in their children and that no items will be dropped in a destination which has its IsDropAllowed property set to false.

This method is not meant to implement business or application logic. The DragDrop events can be handled to implement additional validation / logic.

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object item

The item to check.

Returns
System.Boolean

True if the item is (or is eligible to be) its own container; otherwise, false.

MeasureOverride(Size)

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

Returns
System.Windows.Size

OnApplyTemplate()

Called when the template of the control is being applied.

Declaration
public override void OnApplyTemplate()
Overrides
EditableHeaderedItemsControl.OnApplyTemplate()

OnChecked(RadTreeViewCheckEventArgs)

Raises the Checked event.

Declaration
protected virtual void OnChecked(RadTreeViewCheckEventArgs e)
Parameters
RadTreeViewCheckEventArgs e

The RadTreeViewCheckEventArgs instance containing the event data.

OnClick(RadRoutedEventArgs)

Raises the Click event and tries to execute the Command.

Declaration
protected virtual Nullable<bool> OnClick(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

Returns
System.Nullable<System.Boolean>

True if the command is executed; False if the command can not be executed; Null when command is not set or suppressing notifications.

OnCollapsed(RadRoutedEventArgs)

Raises the Collapsed event.

Declaration
protected virtual void OnCollapsed(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnDoubleClick(RadRoutedEventArgs)

Raises the DoubleClick event and tries to execute the Command.

Declaration
protected virtual Nullable<bool> OnDoubleClick(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

Returns
System.Nullable<System.Boolean>

True if the command is executed; False if the command can not be executed; Null when command is not set or suppressing notifications.

OnExpanded(RadRoutedEventArgs)

Raise the Expanded event.

Declaration
protected virtual void OnExpanded(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

OnGotFocus(RoutedEventArgs)

Called before the System.Windows.UIElement.GotFocus event occurs.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

The data for the event.

Overrides
ItemsControl.OnGotFocus(RoutedEventArgs)

OnHeaderChanged(Object, Object)

Called when the System.Windows.Controls.HeaderedContentControl.Header property of a System.Windows.Controls.HeaderedContentControl changes.

Declaration
protected override void OnHeaderChanged(object oldHeader, object newHeader)
Parameters
System.Object oldHeader

Old value of the System.Windows.Controls.HeaderedContentControl.Header property.

System.Object newHeader

New value of the System.Windows.Controls.HeaderedContentControl.Header property.

Overrides
HeaderedItemsControl.OnHeaderChanged(Object, Object)

OnHeaderEditElementKeyDown(Object, KeyEventArgs)

Called when KeyDown event occurs on the Header Edit Element.

Declaration
protected virtual void OnHeaderEditElementKeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

The sender.

System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs instance containing the event data.

OnIsEnabledChanged(DependencyPropertyChangedEventArgs)

The handler for the IsEnabledChanged event is fired.

Declaration
protected override void OnIsEnabledChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

Overrides
ItemsControl.OnIsEnabledChanged(DependencyPropertyChangedEventArgs)

OnIsExpandedChanged(Boolean, Boolean)

Called when the value of the IsExpanded property changes.

Declaration
protected virtual void OnIsExpandedChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

The old value of the IsExpanded property.

System.Boolean newValue

The new value of the IsExpanded property.

OnIsInEditModeChanged(Boolean, Boolean)

Called when the value of the IsInEditMode property changes.

Declaration
protected override void OnIsInEditModeChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

System.Boolean newValue

Overrides
EditableHeaderedItemsControl.OnIsInEditModeChanged(Boolean, Boolean)

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

Overrides
ItemsControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnKeyDown(KeyEventArgs)

Called before the System.Windows.UIElement.KeyDown event occurs.

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

The data for the event.

OnLoadOnDemand(RadRoutedEventArgs)

Raises the LoadOnDemand event.

Declaration
protected virtual void OnLoadOnDemand(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

OnLostFocus(RoutedEventArgs)

Called before the System.Windows.UIElement.LostFocus event occurs.

Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

The data for the event.

Overrides
ItemsControl.OnLostFocus(RoutedEventArgs)

OnMouseEnter(MouseEventArgs)

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

OnMouseLeave(MouseEventArgs)

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

OnPreviewChecked(RadTreeViewCheckEventArgs)

Raises the PreviewChecked event.

Declaration
protected virtual bool OnPreviewChecked(RadTreeViewCheckEventArgs e)
Parameters
RadTreeViewCheckEventArgs e

The RadRoutedEventArgs instance containing the event data.

Returns
System.Boolean

OnPreviewCollapsed(RadRoutedEventArgs)

Raises the PreviewCollapsed event.

Declaration
protected virtual bool OnPreviewCollapsed(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

Returns
System.Boolean

OnPreviewEditorPrepare(EditorPrepareEventArgs)

Prepares the editor for the TreeViewItem. This override binds the default TextBox to the property that is edited if necessary.

Declaration
protected override void OnPreviewEditorPrepare(EditorPrepareEventArgs e)
Parameters
EditorPrepareEventArgs e

The event arguments that will be passed to the PreviewEditorPrepare in the base implementation.

Overrides
EditableHeaderedItemsControl.OnPreviewEditorPrepare(EditorPrepareEventArgs)

OnPreviewExpanded(RadRoutedEventArgs)

Raises the PreviewExpanded event.

Declaration
protected virtual bool OnPreviewExpanded(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

Returns
System.Boolean

OnPreviewSelected(RadRoutedEventArgs)

Raises the PreviewSelected event.

Declaration
protected virtual bool OnPreviewSelected(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

Returns
System.Boolean

OnPreviewUnchecked(RadTreeViewCheckEventArgs)

Raises the PreviewUnchecked event.

Declaration
protected virtual bool OnPreviewUnchecked(RadTreeViewCheckEventArgs e)
Parameters
RadTreeViewCheckEventArgs e

The EventArgs instance containing the event data.

Returns
System.Boolean

OnPreviewUnselected(RadRoutedEventArgs)

Raises the PreviewUnselected event.

Declaration
protected virtual bool OnPreviewUnselected(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

Returns
System.Boolean

OnSelected(RadRoutedEventArgs)

Raises the Selected event.

Declaration
protected virtual void OnSelected(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

OnUnchecked(RadTreeViewCheckEventArgs)

Raises the Unchecked event.

Declaration
protected virtual void OnUnchecked(RadTreeViewCheckEventArgs e)
Parameters
RadTreeViewCheckEventArgs e

The RadTreeViewCheckEventArgs instance containing the event data.

OnUnselected(RadRoutedEventArgs)

Raises the Unselected event.

Declaration
protected virtual void OnUnselected(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs e

The RadRoutedEventArgs instance containing the event data.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.

System.Object item

Specified item.

Overrides
ItemsControl.PrepareContainerForItemOverride(DependencyObject, Object)

ToString()

Return item text value.

Declaration
public override string ToString()
Returns
System.String

The text of the item.

Events

Checked

Occurs when the item is checked.

Declaration
public event EventHandler<RadRoutedEventArgs> Checked
Event Type
System.EventHandler<RadRoutedEventArgs>

Click

Occurs after the tree item is clicked.

Declaration
public event EventHandler<RadRoutedEventArgs> Click
Event Type
System.EventHandler<RadRoutedEventArgs>

Collapsed

Occurs after the tree item is collapsed.

Declaration
public event EventHandler<RadRoutedEventArgs> Collapsed
Event Type
System.EventHandler<RadRoutedEventArgs>

DoubleClick

Occurs after the tree item is double clicked.

Declaration
public event EventHandler<RadRoutedEventArgs> DoubleClick
Event Type
System.EventHandler<RadRoutedEventArgs>

Expanded

Occurs after the tree item is expanded.

Declaration
public event EventHandler<RadRoutedEventArgs> Expanded
Event Type
System.EventHandler<RadRoutedEventArgs>

LoadOnDemand

Occurs when the tree item should load its child items on demand.

Declaration
public event EventHandler<RadRoutedEventArgs> LoadOnDemand
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewChecked

Occurs before the tree item is checked.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewChecked
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewCollapsed

Occurs before an item is collapsed.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewCollapsed
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewExpanded

Occurs before an item is expanded.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewExpanded
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewSelected

Occurs before the tree item is selected.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewSelected
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewUnchecked

Occurs before the tree item is unchecked.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewUnchecked
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewUnselected

Occurs before an item is unselected.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewUnselected
Event Type
System.EventHandler<RadRoutedEventArgs>

Selected

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

Declaration
public event EventHandler<RadRoutedEventArgs> Selected
Event Type
System.EventHandler<RadRoutedEventArgs>

Unchecked

Occurs when the item is unchecked.

Declaration
public event EventHandler<RadRoutedEventArgs> Unchecked
Event Type
System.EventHandler<RadRoutedEventArgs>

Unselected

Occurs after the tree item is unselected.

Declaration
public event EventHandler<RadRoutedEventArgs> Unselected
Event Type
System.EventHandler<RadRoutedEventArgs>

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)
EnumerableExtensions.ToEnumerable<T>(T)

Was this article helpful?

Tell us how we can improve this article

Skip
Getting Started
  • Install Now
  • Demos
  • SDK Samples Browser
  • Sample Applications
  • Themes Generator
Support Resources
  • Code Library
  • Knowledge Base
  • MVVM Support
  • Videos
  • GitHub SDK Repository
  • System Requirements
Community
  • Forums
  • Blogs
  • XAML Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.