Class

RadTreeViewItem

Initializes a new instance of the RadTreeViewItem class.

Declaration

public RadTreeViewItem()

Identifies the CheckState dependency property.

Declaration

public static readonly DependencyProperty CheckStateProperty

Field Value

Identifies the Checked routed event.

Declaration

public static readonly RoutedEvent CheckedEvent

Field Value

Identifies the Click routed event.

Declaration

public static readonly RoutedEvent ClickEvent

Field Value

Identifies the Collapsed routed event.

Declaration

public static readonly RoutedEvent CollapsedEvent

Field Value

Identifies the CommandExecutionTrigger dependency property.

Declaration

public static readonly DependencyProperty CommandExecutionTriggerProperty

Field Value

Identifies the CommandParameter dependency property.

Declaration

public static readonly DependencyProperty CommandParameterProperty

Field Value

Identifies the ClickCommand dependency property.

Declaration

public static readonly DependencyProperty CommandProperty

Field Value

Identifies the CommandTarget dependency property.

Declaration

public static readonly DependencyProperty CommandTargetProperty

Field Value

Identifies the DefaultImageSrc dependency property.

Declaration

public static readonly DependencyProperty DefaultImageSrcProperty

Field Value

Identifies the DoubleClick routed event.

Declaration

public static readonly RoutedEvent DoubleClickEvent

Field Value

Identifies the DropPosition property.

Declaration

public static readonly DependencyProperty DropPositionProperty

Field Value

Identifies the Expanded routed event.

Declaration

public static readonly RoutedEvent ExpandedEvent

Field Value

Identifies the ExpandedImageSrc dependency property.

Declaration

public static readonly DependencyProperty ExpandedImageSrcProperty

Field Value

Identifies the ExpanderButtonMinWidth dependency property.

Declaration

public static readonly DependencyProperty ExpanderButtonMinWidthProperty

Field Value

Identifies the ExpanderStyle dependency property.

Declaration

public static readonly DependencyProperty ExpanderStyleProperty

Field Value

Identifies the IsCheckBoxEnabled dependency property.

Declaration

public static readonly DependencyProperty IsCheckBoxEnabledProperty

Field Value

Identifies the IsChecked property.

Declaration

public static readonly DependencyProperty IsCheckedProperty

Field Value

Identifies the IsDragOver property.

Declaration

public static readonly DependencyProperty IsDragOverProperty

Field Value

Identifies the IsDropAllowed dependency property.

Declaration

public static readonly DependencyProperty IsDropAllowedProperty

Field Value

Identifies the IsExpanded dependency property.

Declaration

public static readonly DependencyProperty IsExpandedProperty

Field Value

Identifies the IsLoadOnDemandEnabled dependency property.

Declaration

public static readonly DependencyProperty IsLoadOnDemandEnabledProperty

Field Value

Identifies the IsLoadingOnDemand dependency property.

Declaration

public static readonly DependencyProperty IsLoadingOnDemandProperty

Field Value

Identifies the IsMouseOverHeader dependency property.

Declaration

public static readonly DependencyProperty IsMouseOverHeaderProperty

Field Value

Identifies the IsSelectable dependency property.

Declaration

public static readonly DependencyProperty IsSelectableProperty

Field Value

Identifies the IsSelected dependency property.

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Identifies the IsSelectionActive dependency property.

Declaration

public static readonly DependencyProperty IsSelectionActiveProperty

Field Value

Identifies the IsSelectionActivePropertyKey dependency property.

Declaration

public static readonly DependencyPropertyKey IsSelectionActivePropertyKey

Field Value

Identifies the ItemVisibility dependency property.

Declaration

public static readonly DependencyProperty ItemVisibilityProperty

Field Value

Identifies the LoadOnDemand routed event.

Declaration

public static readonly RoutedEvent LoadOnDemandEvent

Field Value

Identifies the OptionTypeProperty dependency property.

Declaration

public static readonly DependencyProperty OptionTypeProperty

Field Value

Identifies the PreviewChecked routed event.

Declaration

public static readonly RoutedEvent PreviewCheckedEvent

Field Value

Identifies the PreviewCollapsed routed event.

Declaration

public static readonly RoutedEvent PreviewCollapsedEvent

Field Value

Identifies the PreviewExpanded routed event.

Declaration

public static readonly RoutedEvent PreviewExpandedEvent

Field Value

Identifies the PreviewSelected routed event.

Declaration

public static readonly RoutedEvent PreviewSelectedEvent

Field Value

Identifies the PreviewUnchecked routed event.

Declaration

public static readonly RoutedEvent PreviewUncheckedEvent

Field Value

Identifies the PreviewUnselected routed event.

Declaration

public static readonly RoutedEvent PreviewUnselectedEvent

Field Value

Identifies the Selected routed event.

Declaration

public static readonly RoutedEvent SelectedEvent

Field Value

Identifies the SelectedImageSrc dependency property.

Declaration

public static readonly DependencyProperty SelectedImageSrcProperty

Field Value

Identifies the Unchecked routed event.

Declaration

public static readonly RoutedEvent UncheckedEvent

Field Value

Identifies the Unselected routed event.

Declaration

public static readonly RoutedEvent UnselectedEvent

Field Value

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

Declaration

public ToggleState CheckState { get; set; }

Property Value

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

Declaration

public ICommand Command { get; set; }

Property Value

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

Declaration

public CommandExecutionTrigger CommandExecutionTrigger { get; set; }

Property Value

Gets or sets the command parameter of the RadTreeViewItem.

Declaration

public object CommandParameter { get; set; }

Property Value

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

Declaration

public IInputElement CommandTarget { get; set; }

Property Value

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

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Src")]
public virtual object DefaultImageSrc { get; set; }

Property Value

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

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

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Src")]
public object ExpandedImageSrc { get; set; }

Property Value

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

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

Declaration

public Style ExpanderStyle { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public string FullPath { get; }

Property Value

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

Declaration

[Browsable(false)]
public int Index { get; }

Property Value

Gets whether the tree item will display a check box.

Declaration

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

Property Value

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

Declaration

public bool? IsChecked { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public bool IsDragOver { get; set; }

Property Value

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

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

Declaration

public bool IsExpanded { get; set; }

Property Value

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

Declaration

public bool IsInSelectedPath { get; }

Property Value

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

Declaration

[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]
public bool IsInViewport { get; }

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 whether the tree item is in loading on demand state.

Declaration

public bool IsLoadingOnDemand { get; set; }

Property Value

Remarks

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

Declaration

public bool IsMouseOverHeader { get; }

Property Value

Gets a value if the item is root item.

Declaration

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

Property Value

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

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

Declaration

public bool IsSelected { get; set; }

Property Value

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

Declaration

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

Property Value

Gets the data item associated to the RadTreeViewItem.

Declaration

public object Item { get; }

Property Value

Remarks

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

Declaration

public Visibility ItemVisibility { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public int Level { get; }

Property Value

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

Declaration

[Browsable(false)]
public RadTreeViewItem NextItem { get; }

Property Value

Gets the next sibling tree item.

Declaration

[Browsable(false)]
public RadTreeViewItem NextSiblingItem { get; }

Property Value

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

Declaration

public OptionListType OptionType { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public RadTreeViewItem ParentItem { get; }

Property Value

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

Declaration

[Browsable(false)]
public RadTreeView ParentTreeView { get; }

Property Value

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

Declaration

[Browsable(false)]
public RadTreeViewItem PreviousItem { get; }

Property Value

Gets the previous sibling tree item.

Declaration

[Browsable(false)]
public RadTreeViewItem PreviousSiblingItem { get; }

Property Value

Gets the root parent item for this instance.

Declaration

public RadTreeViewItem RootItem { get; }

Property Value

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

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Src")]
public object SelectedImageSrc { get; set; }

Property Value

Attempts to start editing the item.

Declaration

public override bool BeginEdit()

Returns

Overrides EditableHeaderedItemsControl.BeginEdit()

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

Cancels the edit.

Declaration

public override bool CancelEdit()

Returns

Overrides EditableHeaderedItemsControl.CancelEdit()

Updates the visual state of the control.

Declaration

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

Parameters

Overrides EditableHeaderedItemsControl.ChangeVisualState(bool)

When overridden in a derived class, undoes the effects of the method.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Collapses the item and its child items recursively.

Declaration

public void CollapseAll()

Tries to Commit edit.

Declaration

public override bool CommitEdit()

Returns

Overrides EditableHeaderedItemsControl.CommitEdit()

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

Declaration

public bool Contains(RadTreeViewItem item)

Parameters

Returns

Ensures that a given item is displayed.

Declaration

public void EnsureVisible()

Expands the item and its child items recursively.

Declaration

public void ExpandAll()

Remarks

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

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

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

Declaration

public bool IsBefore(RadTreeViewItem item)

Parameters

Returns

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

Declaration

[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity", Justification = "It will be refactored.")]
public virtual bool IsDropPossible(IEnumerable draggedItems)

Parameters

Returns

Remarks

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

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Returns

Measures the size of the control.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Returns

Called to apply the template to the RadTreeViewItem. This method is responsible for performing any necessary operations when the control's visual tree is generated.

Declaration

public override void OnApplyTemplate()

Overrides EditableHeaderedItemsControl.OnApplyTemplate()

Remarks

Raises the event.

Declaration

protected virtual void OnChecked(RadTreeViewCheckEventArgs e)

Parameters

Raises the event and tries to execute the .

Declaration

protected virtual bool? OnClick(RadRoutedEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnCollapsed(RadRoutedEventArgs e)

Parameters

Returns class-specific AutomationPeer.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the event and tries to execute the .

Declaration

protected virtual bool? OnDoubleClick(RadRoutedEventArgs e)

Parameters

Returns

Raise the event.

Declaration

protected virtual void OnExpanded(RadRoutedEventArgs e)

Parameters

Called before the event occurs.

Declaration

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

Called when the property of a changes.

Declaration

protected override void OnHeaderChanged(object oldHeader, object newHeader)

Parameters

Called when KeyDown event occurs on the Header Edit Element.

Declaration

[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers", Justification = "There is no need to make the emthod private.")]
protected virtual void OnHeaderEditElementKeyDown(object sender, KeyEventArgs e)

Parameters

Raises the event. This method is invoked whenever is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

The handler for the IsEnabledChanged event is fired.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "e", Justification = "This is a standard name for event arguments")]
[SuppressMessage("Microsoft.Design", "CA1061:DoNotHideBaseClassMethods", Justification = "This is an instance method and not a static method, there should be no confusion")]
protected virtual void OnIsEnabledChanged(object sender, DependencyPropertyChangedEventArgs e)

Parameters

Called when the value of the IsExpanded property changes.

Declaration

[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
protected virtual void OnIsExpandedChanged(bool oldValue, bool newValue)

Parameters

Called when the value of the IsInEditMode property changes.

Declaration

protected override void OnIsInEditModeChanged(bool oldValue, bool newValue)

Parameters

Overrides EditableHeaderedItemsControl.OnIsInEditModeChanged(bool, bool)

Invoked when the Items property changes.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Called before the event occurs.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnLoadOnDemand(RadRoutedEventArgs e)

Parameters

Called before the event occurs.

Declaration

protected override void OnLostFocus(RoutedEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual bool OnPreviewChecked(RadTreeViewCheckEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewCollapsed(RadRoutedEventArgs e)

Parameters

Returns

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

Overrides EditableHeaderedItemsControl.OnPreviewEditorPrepare(EditorPrepareEventArgs)

Raises the event.

Declaration

protected virtual bool OnPreviewExpanded(RadRoutedEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewSelected(RadRoutedEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewUnchecked(RadTreeViewCheckEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewUnselected(RadRoutedEventArgs e)

Parameters

Returns

Raises the event.

Declaration

protected virtual void OnSelected(RadRoutedEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnUnchecked(RadTreeViewCheckEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnUnselected(RadRoutedEventArgs e)

Parameters

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Return item text value.

Declaration

public override string ToString()

Returns

Occurs when the item is checked.

Declaration

public event EventHandler<RadRoutedEventArgs> Checked

Event Value

Occurs after the tree item is clicked.

Declaration

public event EventHandler<RadRoutedEventArgs> Click

Event Value

Occurs after the tree item is collapsed.

Declaration

public event EventHandler<RadRoutedEventArgs> Collapsed

Event Value

Occurs after the tree item is double clicked.

Declaration

public event EventHandler<RadRoutedEventArgs> DoubleClick

Event Value

Occurs after the tree item is expanded.

Declaration

public event EventHandler<RadRoutedEventArgs> Expanded

Event Value

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

Declaration

public event EventHandler<RadRoutedEventArgs> LoadOnDemand

Event Value

Occurs before the tree item is checked.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewChecked

Event Value

Occurs before an item is collapsed.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewCollapsed

Event Value

Occurs before an item is expanded.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewExpanded

Event Value

Occurs before the tree item is selected.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewSelected

Event Value

Occurs before the tree item is unchecked.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewUnchecked

Event Value

Occurs before an item is unselected.

Declaration

public event EventHandler<RadRoutedEventArgs> PreviewUnselected

Event Value

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

Declaration

public event EventHandler<RadRoutedEventArgs> Selected

Event Value

Occurs when the item is unchecked.

Declaration

public event EventHandler<RadRoutedEventArgs> Unchecked

Event Value

Occurs after the tree item is unselected.

Declaration

public event EventHandler<RadRoutedEventArgs> Unselected

Event Value