ClassTreeViewDragCue
The visual object used as a DragCue in the TreeView.
Definition
Namespace:Telerik.Windows.Controls.TreeView
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
public class TreeViewDragCue : ItemsControlInheritance: objectTreeViewDragCue
Constructors
TreeViewDragCue()
Declaration
public TreeViewDragCue()Fields
DragActionContentProperty
Identifies the DragActionContent property.
Declaration
public static readonly DependencyProperty DragActionContentPropertyField Value
DependencyProperty
DragActionContentTemplateProperty
Identifies the DragActionContentTemplate property.
Declaration
public static readonly DependencyProperty DragActionContentTemplatePropertyField Value
DependencyProperty
DragPreviewVisibilityProperty
Identifies the DragPreviewVisibility property.
Declaration
public static readonly DependencyProperty DragPreviewVisibilityPropertyField Value
DependencyProperty
DragTooltipContentProperty
Identifies the DragTooltipContent property.
Declaration
public static readonly DependencyProperty DragTooltipContentPropertyField Value
DependencyProperty
DragTooltipContentTemplateProperty
Identifies the DragTooltipContentTemplate property.
Declaration
public static readonly DependencyProperty DragTooltipContentTemplatePropertyField Value
DependencyProperty
DragTooltipVisibilityProperty
Identifies the DragTooltipVisibility property.
Declaration
public static readonly DependencyProperty DragTooltipVisibilityPropertyField Value
DependencyProperty
DropImpossibleIconProperty
Identifies the DropImpossibleIcon property.
Declaration
public static readonly DependencyProperty DropImpossibleIconPropertyField Value
DependencyProperty
DropImpossibleIconTemplateProperty
Identifies the DropImpossibleIcon property.
Declaration
public static readonly DependencyProperty DropImpossibleIconTemplatePropertyField Value
DependencyProperty
DropPossibleIconProperty
Identifies the DropPossibleIcon property.
Declaration
public static readonly DependencyProperty DropPossibleIconPropertyField Value
DependencyProperty
DropPossibleIconTemplateProperty
Identifies the DropPossibleIconTemplate property.
Declaration
public static readonly DependencyProperty DropPossibleIconTemplatePropertyField Value
DependencyProperty
IsDropPossibleProperty
Identifies the IsDropPossible property.
Declaration
public static readonly DependencyProperty IsDropPossiblePropertyField Value
DependencyProperty
Properties
DragActionContent
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.
DragActionContentTemplate
Gets or sets the template for the DragActionContent. This is a dependency property.
Declaration
public DataTemplate DragActionContentTemplate { get; set; }Property Value
DataTemplate
DragPreviewVisibility
Gets or sets the visibility of the area showing a the dragged items. This is a dependency property.
Declaration
public Visibility DragPreviewVisibility { get; set; }Property Value
Visibility
DragTooltipContent
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.
DragTooltipContentTemplate
Gets or sets the data template for the DragTooltip content. This is a dependency property.
Declaration
public DataTemplate DragTooltipContentTemplate { get; set; }Property Value
DataTemplate
DragTooltipVisibility
Gets or sets the visibility of the tooltip showing an icon, action text and a preview of the destination. This is a dependency property.
Declaration
public Visibility DragTooltipVisibility { get; set; }Property Value
Visibility
DropImpossibleIcon
Gets or sets the content that will appear as an icon when the a drop is not possible. This is a dependency property.
DropImpossibleIconTemplate
Gets or sets the data template of the object that will be shown when a drop is not possible. This is a dependency property.
Declaration
public DataTemplate DropImpossibleIconTemplate { get; set; }Property Value
DataTemplate
DropPossibleIcon
Gets or sets the content that will appear as an icon when the a drop is possible. This is a dependency property.
DropPossibleIconTemplate
Gets or sets the data template of the object that will be shown when a drop is possible. This is a dependency property.
Declaration
public DataTemplate DropPossibleIconTemplate { get; set; }Property Value
DataTemplate
IsDropPossible
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.
Methods
ChangeVisualState(bool)
Updates the visual state of the control.
Declaration
[SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", MessageId = "useTransitions")]
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
protected void ChangeVisualState(bool useTransitions)Parameters
useTransitions
Indicates whether transitions should be used.
GetNonVisualRepresentation(object)
Return a non-visual representation of an item. This is helpful when DragPreview of visual items needs to be shown.
Declaration
public static object GetNonVisualRepresentation(object item)Parameters
item
The item to return non-visual representation for.
Returns
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.
OnApplyTemplate()
Called when the control template is applied; used to initialize the TreeView drag cue.
Declaration
public override void OnApplyTemplate()OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The RoutedEventArgs that contains the event data.
ResetTheme()
Resets the theme of the TreeViewDragCue.
Declaration
public void ResetTheme()SetSafeItemsSource(IEnumerable)
Sets the ItemsSource, extract non-visual representation of all visual items to avoid errors.
Declaration
public void SetSafeItemsSource(IEnumerable itemsSource)Parameters
itemsSource
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.