New to Telerik UI for WPFStart a free 30-day trial

The visual object used as a DragCue in the TreeView.

Definition

Namespace:Telerik.Windows.Controls.TreeView

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

C#
public class TreeViewDragCue : ItemsControl

Inheritance: objectTreeViewDragCue

Constructors

C#
public TreeViewDragCue()

Fields

DragActionContentProperty

DependencyProperty

Identifies the DragActionContent property.

C#
public static readonly DependencyProperty DragActionContentProperty

Identifies the DragActionContentTemplate property.

C#
public static readonly DependencyProperty DragActionContentTemplateProperty

Identifies the DragPreviewVisibility property.

C#
public static readonly DependencyProperty DragPreviewVisibilityProperty

DragTooltipContentProperty

DependencyProperty

Identifies the DragTooltipContent property.

C#
public static readonly DependencyProperty DragTooltipContentProperty

Identifies the DragTooltipContentTemplate property.

C#
public static readonly DependencyProperty DragTooltipContentTemplateProperty

Identifies the DragTooltipVisibility property.

C#
public static readonly DependencyProperty DragTooltipVisibilityProperty

DropImpossibleIconProperty

DependencyProperty

Identifies the DropImpossibleIcon property.

C#
public static readonly DependencyProperty DropImpossibleIconProperty

Identifies the DropImpossibleIcon property.

C#
public static readonly DependencyProperty DropImpossibleIconTemplateProperty

DropPossibleIconProperty

DependencyProperty

Identifies the DropPossibleIcon property.

C#
public static readonly DependencyProperty DropPossibleIconProperty

Identifies the DropPossibleIconTemplate property.

C#
public static readonly DependencyProperty DropPossibleIconTemplateProperty

IsDropPossibleProperty

DependencyProperty

Identifies the IsDropPossible property.

C#
public static readonly DependencyProperty IsDropPossibleProperty

Properties

Gets or sets the content that will appear in the DragCue and is meant to represent the possible drop action. This is a dependency property.

C#
public object DragActionContent { get; set; }

Gets or sets the template for the DragActionContent. This is a dependency property.

C#
public DataTemplate DragActionContentTemplate { get; set; }

Gets or sets the visibility of the area showing a the dragged items. This is a dependency property.

C#
public Visibility DragPreviewVisibility { get; set; }

Gets or sets the content that will appear in the tooltip of the DragCue. Often this is the destination item is placed here. This is a dependency property.

C#
public object DragTooltipContent { get; set; }

Gets or sets the data template for the DragTooltip content. This is a dependency property.

C#
public DataTemplate DragTooltipContentTemplate { get; set; }

Gets or sets the visibility of the tooltip showing an icon, action text and a preview of the destination. This is a dependency property.

C#
public Visibility DragTooltipVisibility { get; set; }

Gets or sets the content that will appear as an icon when the a drop is not possible. This is a dependency property.

C#
public object DropImpossibleIcon { get; set; }

Gets or sets the data template of the object that will be shown when a drop is not possible. This is a dependency property.

C#
public DataTemplate DropImpossibleIconTemplate { get; set; }

Gets or sets the content that will appear as an icon when the a drop is possible. This is a dependency property.

C#
public object DropPossibleIcon { get; set; }

Gets or sets the data template of the object that will be shown when a drop is possible. This is a dependency property.

C#
public DataTemplate DropPossibleIconTemplate { get; set; }

Gets or sets a value indicating whether a drop is possible. This value only changes the DragCue and may not be related to whether a drop could actually happen. This is a dependency property.

C#
public bool IsDropPossible { get; set; }

Methods

Updates the visual state of the control.

C#
protected void ChangeVisualState(bool useTransitions)
Parameters:useTransitionsbool

Indicates whether transitions should be used.

Return a non-visual representation of an item. This is helpful when DragPreview of visual items needs to be shown.

C#
public static object GetNonVisualRepresentation(object item)
Parameters:itemobject

The item to return non-visual representation for.

Returns:

object

A non-visual representation of an item.

Remarks:

The NonVisual representation will fallback like so, trying to return:

  • Non-visual Header of Headered Controls
  • Non-visual Content of Content Controls
  • Non-visual DataContext
  • TextSearch.Text Property
  • Item itself.

Called when the control template is applied; used to initialize the TreeView drag cue.

C#
public override void OnApplyTemplate()

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

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Resets the theme of the TreeViewDragCue.

C#
public void ResetTheme()

Sets the ItemsSource, extract non-visual representation of all visual items to avoid errors.

C#
public void SetSafeItemsSource(IEnumerable itemsSource)
Parameters:itemsSourceIEnumerable

The items that will be shown in the preview area.

Remarks:

Since visual items cannot be present at two places at the same time, this method will assign an ItemsSource but before that it will try to find a non-visual representation of the visual items.

If the items are non-visual, it keeps them. Then it checks for explicit DataContext of the item. If it has one, it uses it. Then, it checks for the TextSearch.Text property. If it is not set, it returns the ToString() of the item.

Please note that the method does a collection-equals check for and it will not replace the current ItemsSource if the same items are in the new and the old collection. This means that a new ItemsSource will not be set if the new items are just a rearrangement of the old.