Class

RadTreeView

Initializes a new instance of the RadTreeView class.

Declaration

public RadTreeView()

Remarks

Identifies the AutoScrollToSelectedItem property.

Declaration

public static readonly DependencyProperty AutoScrollToSelectedItemProperty

Field Value

Identifies the BringIntoView property.

Declaration

public static readonly DependencyProperty BringIntoViewModeProperty

Field Value

Identifies the CheckedItemsProperty dependency property.

Declaration

public static readonly DependencyProperty CheckedItemsProperty

Field Value

Identifies the DragEnded routed event.

Declaration

[Obsolete("This property will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public static readonly RoutedEvent DragEndedEvent

Field Value

Identifies the DragOverTree routed event.

Declaration

[Obsolete("This property will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public static readonly RoutedEvent DragOverTreeEvent

Field Value

Identifies the DragStarted routed event.

Declaration

[Obsolete("This property will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public static readonly RoutedEvent DragStartedEvent

Field Value

Identifies the DropExpandDelay property.

Declaration

public static readonly DependencyProperty DropExpandDelayProperty

Field Value

Identifies the ExpanderStyle dependency property.

Declaration

public static readonly DependencyProperty ExpanderStyleProperty

Field Value

Identifies the ImagesBaseDirectory dependency property.

Declaration

public static readonly DependencyProperty ImagesBaseDirProperty

Field Value

Identifies the IsDragDropEnabled dependency property.

Declaration

public static readonly DependencyProperty IsDragDropEnabledProperty

Field Value

Identifies the IsDragPreviewEnabled dependency property.

Declaration

public static readonly DependencyProperty IsDragPreviewEnabledProperty

Field Value

Identifies the IsDragTooltipEnabled dependency property.

Declaration

public static readonly DependencyProperty IsDragTooltipEnabledProperty

Field Value

Identifies the IsDropPreviewLineEnabled dependency property.

Declaration

public static readonly DependencyProperty IsDropPreviewLineEnabledProperty

Field Value

Identifies the IsEditable dependency property.

Declaration

public static readonly DependencyProperty IsEditableProperty

Field Value

Identifies the IsExpandOnDoubleClickEnabled dependency property.

Declaration

public static readonly DependencyProperty IsExpandOnDblClickEnabledProperty

Field Value

Identifies the IsExpandOnSingleClickEnabled dependency property.

Declaration

public static readonly DependencyProperty IsExpandOnSingleClickEnabledProperty

Field Value

Identifies the IsLineEnabled dependency property.

Declaration

public static readonly DependencyProperty IsLineEnabledProperty

Field Value

Identifies the IsLoadOnDemandEnabled dependency property.

Declaration

public static readonly DependencyProperty IsLoadOnDemandEnabledProperty

Field Value

Identifies the IsOptionElementsEnabled dependency property.

Declaration

public static readonly DependencyProperty IsOptionElementsEnabledProperty

Field Value

Identifies the IsRootLinesEnabled dependency property.

Declaration

public static readonly DependencyProperty IsRootLinesEnabledProperty

Field Value

Identifies the IsSingleExpandPath dependency property.

Declaration

public static readonly DependencyProperty IsSingleExpandPathProperty

Field Value

Identifies the IsTriStateMode dependency property.

Declaration

public static readonly DependencyProperty IsTriStateModeProperty

Field Value

Identifies the ItemEditTemplate dependency property.

Declaration

public static readonly DependencyProperty ItemEditTemplateProperty

Field Value

Identifies the ItemEditTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty ItemEditTemplateSelectorProperty

Field Value

Identifies the ItemsIndent dependency property.

Declaration

public static readonly DependencyProperty ItemsIndentProperty

Field Value

Identifies the PathSeparator dependency property.

Declaration

public static readonly DependencyProperty PathSeparatorProperty

Field Value

Identifies the PerformSelectionOnMouseUp property.

Declaration

public static readonly DependencyProperty PerformSelectionOnMouseUpProperty

Field Value

Identifies the PreviewDragEnded routed event.

Declaration

[Obsolete("This property will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public static readonly RoutedEvent PreviewDragEndedEvent

Field Value

Identifies the PreviewDragStarted routed event.

Declaration

[Obsolete("This property will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public static readonly RoutedEvent PreviewDragStartedEvent

Field Value

Identifies the PreviewSelectionChanged routed event.

Declaration

public static readonly RoutedEvent PreviewSelectionChangedEvent

Field Value

Identifies the SelectedContainer property.

Declaration

public static readonly DependencyProperty SelectedContainerProperty

Field Value

Identifies the SelectedItem property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Identifies the SelectedItemsProperty dependency property.

Declaration

public static readonly DependencyProperty SelectedItemsProperty

Field Value

Identifies the SelectedValuePath dependency property.

Declaration

public static readonly DependencyProperty SelectedValuePathProperty

Field Value

Identifies the SelectedValue dependency property.

Declaration

public static readonly DependencyProperty SelectedValueProperty

Field Value

Identifies the SelectionChanged routed event.

Declaration

public static readonly RoutedEvent SelectionChangedEvent

Field Value

Identifies the SelectionMode dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

Identifies the TextDropAfter dependency property.

Declaration

public static readonly DependencyProperty TextDropAfterProperty

Field Value

Identifies the TextDropBefore dependency property.

Declaration

public static readonly DependencyProperty TextDropBeforeProperty

Field Value

Identifies the TextDropIn dependency property.

Declaration

public static readonly DependencyProperty TextDropInProperty

Field Value

Identifies the TextDropRoot dependency property.

Declaration

public static readonly DependencyProperty TextDropRootProperty

Field Value

Identifies the TextSearchMode dependency property.

Declaration

public static readonly DependencyProperty TextSearchModeProperty

Field Value

Gets or sets a value indicating whether the selected RadTreeViewItem should be scrolled into the viewport. When using virtualization this property works only for realized RadTreeViewItem(s).

Declaration

public bool AutoScrollToSelectedItem { get; set; }

Property Value

Gets or sets whether just the item's header should be brought into view when the respective methods are called of the header and its items.

Declaration

public BringIntoViewMode BringIntoViewMode { get; set; }

Property Value

Gets a collection containing the items that are currently checked.

Declaration

public ICollection<object> CheckedItems { get; }

Property Value

Gets or sets the time has to pass before an item will be expanded because of something being dragged over it. This is a dependency property.

Declaration

public TimeSpan DropExpandDelay { get; set; }

Property Value

Gets or sets the style of RadTreeViewItem expander button.

Declaration

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

Property Value

Remarks

Gets or sets the directory where image files used for the TreeView images.

Declaration

public string ImagesBaseDir { get; set; }

Property Value

Gets or sets a value indicating whether drag and drop is enabled.

Declaration

public bool IsDragDropEnabled { get; set; }

Property Value

Gets or sets a value indicating whether drag feedback is shown while dragging.

Declaration

public bool IsDragPreviewEnabled { get; set; }

Property Value

Gets or sets a value indicating whether drag tooltip is shown while dragging.

Declaration

public bool IsDragTooltipEnabled { get; set; }

Property Value

Gets or sets a value indicating whether drag outline is shown while dragging.

Declaration

public bool IsDropPreviewLineEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the user can edit the TreeViewItems.

Declaration

public bool IsEditable { get; set; }

Property Value

Gets if there is an open editor in the tree view.

Declaration

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

Property Value

Gets or sets a value whether the item will toggle its expand state on double click.

Declaration

public bool IsExpandOnDblClickEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the item will toggle its expand state on single click.

Declaration

public bool IsExpandOnSingleClickEnabled { get; set; }

Property Value

Gets or sets a value indicating whether connecting lines are displayed.

Declaration

public bool IsLineEnabled { get; set; }

Property Value

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

Declaration

public bool IsLoadOnDemandEnabled { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether checkboxes/radio buttons are displayed besides the TreeViewItems.

Declaration

public bool IsOptionElementsEnabled { get; set; }

Property Value

Gets or sets a value indicating whether lines are displayed next to root item.

Declaration

public bool IsRootLinesEnabled { get; set; }

Property Value

Gets a value indicating whether only one branch of the TreeView will be expanded.

Declaration

public bool IsSingleExpandPath { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether tri state mode for the checkboxes in the option lists is enabled.

Declaration

public bool IsTriStateMode { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether the TreeView should virtualize its items. Virtualization should be used only when the TreeView is data bound.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Virtualizing", Justification = "This is the correct spelling")]
public bool IsVirtualizing { get; set; }

Property Value

Remarks

Gets or sets the template that the items will display when edited.

Declaration

public DataTemplate ItemEditTemplate { get; set; }

Property Value

Gets or sets the template selector that the items will use to select a template to display when edited.

Declaration

public DataTemplateSelector ItemEditTemplateSelector { get; set; }

Property Value

Gets or sets the distance that each tree item level will be indented.

Declaration

public int ItemsIndent { get; set; }

Property Value

Gets or sets the delimiter string that the tree item path uses.

Declaration

public string PathSeparator { get; set; }

Property Value

Remarks

Gets or sets a boolean value indicating whether the selection will be performed on mouse up.

Declaration

public bool PerformSelectionOnMouseUp { get; set; }

Property Value

Gets the ScrollViewer control the is inside the RadTreeView.

Declaration

public ScrollViewer ScrollViewer { get; }

Property Value

Remarks

Gets the TreeViewItem container that is currently selected. This is a dependency property.

Declaration

public RadTreeViewItem SelectedContainer { get; }

Property Value

Gets or sets the item that is currently selected. This is a dependency property.

Declaration

public object SelectedItem { get; set; }

Property Value

Gets a collection containing the items that are currently selected.

Declaration

[Browsable(false)]
public ObservableCollection<object> SelectedItems { get; }

Property Value

Gets or sets the value of the SelectedItem, obtained by using SelectedValuePath.

Declaration

public object SelectedValue { get; }

Property Value

Gets or sets the path that is used to extract the SelectedValue from the SelectedItem.

Declaration

public string SelectedValuePath { get; set; }

Property Value

Gets or sets the selection mode.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

Gets or sets the text "Drop after" text of the drag preview.

Declaration

public string TextDropAfter { get; set; }

Property Value

Gets or sets the text "Drop before" text of the drag preview.

Declaration

public string TextDropBefore { get; set; }

Property Value

Gets or sets the text for "Drop in" text of the drag preview.

Declaration

public string TextDropIn { get; set; }

Property Value

Gets or sets the text that appears when an item is dropped in an empty TreeView.

Declaration

public string TextDropRoot { get; set; }

Property Value

Gets or sets the text search mode. Specifies how TextSearch will match items. This is a dependency property.

Declaration

public TextSearchMode TextSearchMode { get; set; }

Property Value

Creates a new item and adds a item by path. Can be used if the TreeView is not data bound.

Declaration

public RadTreeViewItem AddItemByPath(string path)

Parameters

Returns

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

Declaration

public RadTreeViewItem AddItemByPath(string path, string separator)

Parameters

Returns

Adds an item at the given path, given that the TreeView is not bound.

Declaration

public RadTreeViewItem AddItemsByPath(string path, string separator)

Parameters

Returns

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

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, Point offset)

Parameters

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

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, Point offset)

Parameters

Brings an item into view. Works recursively for nested containers. If the Loaded event has not been fired yet the method will be scheduled for execution after the Loaded event. The method will realize the required containers if they are not yet created.

Declaration

public void BringPathIntoView(string path)

Parameters

Brings an item into view. Works recursively for nested containers. If the Loaded event has not been fired yet the method will be scheduled for execution after the Loaded event. The method will realize the required containers if they are not yet created.

Declaration

public void BringPathIntoView(string path, Point offset)

Parameters

Updates the visual state of the control.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters")]
protected void ChangeVisualState(bool useTransitions)

Parameters

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Collapses all items recursively.

Declaration

public void CollapseAll()

Recursively searches the tree view in the tree to get an item container (RadTreeViewItem) for the particular data item.

Declaration

public RadTreeViewItem ContainerFromItemRecursive(object item)

Parameters

Returns

Creates default drag visual content - snapshot of all dragged items. Override this method in subclass in order to change the default drag visual content.

Declaration

protected virtual object CreateDragVisualContent(IList<object> draggedItems)

Parameters

Returns

Expands all items recursively.

Declaration

public void ExpandAll()

Remarks

Expands to an item with a given path.

Declaration

public void ExpandItemByPath(string path)

Parameters

Expands to an item with a given path.

Declaration

public void ExpandItemByPath(string path, string separator)

Parameters

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Gets a item by specifying a path to it.

Declaration

public RadTreeViewItem GetItemByPath(string path)

Parameters

Returns

Gets a item by specifying a path to it.

Declaration

public RadTreeViewItem GetItemByPath(string path, string separator)

Parameters

Returns

Hides the drag cue that appears when a drop between two items is possible.

Declaration

[Obsolete("This method will be removed. It is not intended for third party usage.", false)]
public void HideBetweenItemsDragCue()

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Returns

Occurs when the template for the RadTreeView is applied, allowing for custom processing after the template has been applied.

Declaration

public override void OnApplyTemplate()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the event.

Declaration

[Obsolete("This method will be removed. Use DragDropManager API to customize drag drop operations.", false)]
protected virtual void OnDragEnded(RadTreeViewDragEndedEventArgs e)

Parameters

Called when DragEnter Event is Raise.

Declaration

protected override void OnDragEnter(DragEventArgs e)

Parameters

Called when DragEnter Event is Raise.

Declaration

protected override void OnDragLeave(DragEventArgs e)

Parameters

Raises the event.

Declaration

[Obsolete("This method will be removed. Use DragDropManager API to customize drag drop operations.", false)]
protected virtual void OnDragOverTree(DragOverTreeEventArgs e)

Parameters

Raises the event.

Declaration

[Obsolete("This method will be removed. Use DragDropManager API to customize drag drop operations.", false)]
protected virtual void OnDragStarted(RadTreeViewDragEventArgs e)

Parameters

Called when DragEnter Event is Raise.

Declaration

protected override void OnDrop(DragEventArgs e)

Parameters

Propagates the changed expander style through tree's children. Called when the ExpanderStyleInherited property changes.

Declaration

protected virtual void OnExpanderStyleChanged(Style oldStyle, Style newStyle)

Parameters

Called when the TreeView or one of its items receive focus.

Declaration

[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers")]
protected virtual void OnGotFocus(object sender, RoutedEventArgs e)

Parameters

Declaration

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnItemPrepared(RadTreeViewItemPreparedEventArgs e)

Parameters

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Called when the TreeView or one of its items lose focus.

Declaration

[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers")]
protected virtual void OnLostFocus(object sender, RoutedEventArgs e)

Parameters

Declaration

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Declaration

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

Raises the event.

Declaration

[Obsolete("This method will be removed. Use DragDropManager API to customize drag drop operations.", false)]
protected virtual bool OnPreviewDragEnded(RadTreeViewDragEndedEventArgs e)

Parameters

Returns

Raises the event.

Declaration

[Obsolete("This method will be removed. Use DragDropManager API to customize drag drop operations.", false)]
protected virtual bool OnPreviewDragStarted(RadTreeViewDragEventArgs e)

Parameters

Returns

This method is called when the PreviewSelectionChanged is raised.

Declaration

protected virtual bool OnPreviewSelectionChanged(SelectionChangedEventArgs e)

Parameters

Returns

Remarks

Raises the event.

Declaration

protected virtual void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

Declaration

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Resets the theme.

Declaration

public void ResetTheme()

Adds the item with the given path to the collection of selected items. The path separator is "".

Declaration

public void SelectItemByPath(string path)

Parameters

Adds the item with the given path to the collection of selected items. The path separator is "".

Declaration

public void SelectItemByPath(string path, string separator)

Parameters

Shows the DragCue that appears when a drop between two items is possible.

Declaration

[Obsolete("This method will be removed. It is not intended for third party usage.", false)]
public void ShowBetweenItemsDragCue(RadTreeViewItem dropDestination)

Parameters

Updates the drop preview line position and visibility while dragging.

Declaration

public void UpdateDropPreviewLine(RadTreeViewItem dropDestination, DropPosition dropPosition)

Parameters

Occurs when a child TreeView item has been checked.

Declaration

public event EventHandler<RadRoutedEventArgs> Checked

Event Value

Occurs when a child TreeView item has been collapsed.

Declaration

public event EventHandler<RadRoutedEventArgs> Collapsed

Event Value

Occurs when the drag has ended.

Declaration

[Obsolete("This event will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public event RadTreeViewDragEndedEventHandler DragEnded

Event Value

Occurs when the dragging over the tree view.

Declaration

[Obsolete("This event will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public event DragOverTreeEventHandler DragOverTree

Event Value

Occurs when the drag has started.

Declaration

[Obsolete("This event will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public event RadTreeViewDragEventHandler DragStarted

Event Value

Raised when item editing has been canceled. This is a wrapper for the EditableHeaderedItemsControl.EditCanceled routed event.

Declaration

public event RadTreeViewItemEditedEventHandler EditCanceled

Event Value

Raised when the edit of an item has just started. This is a wrapper for the EditableHeaderedItemsControl.EditStarted routed event.

Declaration

public event RadTreeViewItemEditedEventHandler EditStarted

Event Value

Raised when the edit of an item has been committed.

Declaration

public event RadTreeViewItemEditedEventHandler Edited

Event Value

Occurs when a child TreeView item has been expanded.

Declaration

public event EventHandler<RadRoutedEventArgs> Expanded

Event Value

Occurs when a child TreeView item has been clicked.

Declaration

public event EventHandler<RadRoutedEventArgs> ItemClick

Event Value

Occurs when a child TreeView item has been double clicked.

Declaration

public event EventHandler<RadRoutedEventArgs> ItemDoubleClick

Event Value

Occurs when a child RadTreeViewItem has been prepared and is ready for use.

Declaration

public event EventHandler<RadTreeViewItemPreparedEventArgs> ItemPrepared

Event Value

Remarks

Occurs when a child TreeView item is loading its child items on demand. See the IsLoadOnDemandEnabled property.

Declaration

public event EventHandler<RadRoutedEventArgs> LoadOnDemand

Event Value

Occurs before a child TreeView item is checked.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewChecked

Event Value

Occurs before a child TreeView item is collapsed.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewCollapsed

Event Value

Occurs before the drag has been ended.

Declaration

[Obsolete("This event will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public event RadTreeViewDragEndedEventHandler PreviewDragEnded

Event Value

Occurs before the drag is started.

Declaration

[Obsolete("This event will be removed. Use DragDropManager API to customize drag drop operations.", false)]
public event RadTreeViewDragEventHandler PreviewDragStarted

Event Value

Raised just before item editing has been canceled. This is a wrapper for the EditableHeaderedItemsControl.PreviewEditCanceled routed event.

Declaration

public event RadTreeViewItemEditedEventHandler PreviewEditCanceled

Event Value

Raised just before editing of an item has started. This is a wrapper for the EditableHeaderedItemsControl.PreviewEditStarted routed event.

Declaration

public event RadTreeViewItemEditedEventHandler PreviewEditStarted

Event Value

Occurs before a TreeView item to accept the new Edited data.

Declaration

public event RadTreeViewItemEditedEventHandler PreviewEdited

Event Value

Occurs before a child TreeView item is expanded.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewExpanded

Event Value

Occurs before a child tree view item is selected.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewSelected

Event Value

Raised just before the selected items collection has changed.

Declaration

public event SelectionChangedEventHandler PreviewSelectionChanged

Event Value

Occurs before a child TreeView item is unchecked.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewUnchecked

Event Value

Occurs before a child tree view item is unselected.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewUnselected

Event Value

Occurs when a child RadTreeView item has been selected.

Declaration

public event EventHandler<RadRoutedEventArgs> Selected

Event Value

Occurs after the value of the SelectedItems property of a tree is changed.

Declaration

public event SelectionChangedEventHandler SelectionChanged

Event Value

Occurs when a child TreeView item has been unchecked.

Declaration

public event EventHandler<RadRoutedEventArgs> Unchecked

Event Value

Occurs when a child tree view item has been unselected.

Declaration

public event EventHandler<RadRoutedEventArgs> Unselected

Event Value