Class TreeViewDragDropOptions

Encapsulates option and settings related to drag drop operation in RadTreeView. This class provides a mechanism to customize or alter default behavior. An instance of this class is created automatically when a drag drop operation has been started from a RadTreeViewItem object and is used to control the operation while dragging/dropping over other RadTreeViewItem or RadTreeView objects.

Inheritance
System.Object
TreeViewDragDropOptions
Namespace: Telerik.Windows.Controls.TreeView
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

public class TreeViewDragDropOptions : Object

Constructors

TreeViewDragDropOptions()

Initializes a new instance of the TreeViewDragDropOptions class.

Declaration
public TreeViewDragDropOptions()

Fields

Key

Gets a string identification of the class. This property could be used to add/remove objects of this class to/from string dictionaries.

Declaration
public static readonly string Key
Field Value
System.String

Properties

DraggedItems

Get the dragged items.

Declaration
public IEnumerable<object> DraggedItems { get; }
Property Value
System.Collections.Generic.IEnumerable<System.Object>

DragSourceItem

Gets the RadTreeViewItem which started the drag drop operation. Initialized when drag operation starts. Note this property will be null if drag drop operation has been started outside RadTreeViewItem object.

Declaration
public RadTreeViewItem DragSourceItem { get; set; }
Property Value
RadTreeViewItem

DragVisual

Gets or sets a visual representation of the drag drop operation state. By default a TreeViewDragVisual object is created automatically. The TreeViewDragVisual displays an image of dragged items and a textual representation of drop position.

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

DropAction

Gets or sets the drop action that should be executed when drag drop operation completes.

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

DropPosition

Gets or sets the drop position of dragged items.

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

DropTargetItem

Gets the RadTreeViewItem under the drop point. Initialized when drop operation completes. This property will be null if the drop is executed outside RadTreeViewItem.

Declaration
public RadTreeViewItem DropTargetItem { get; set; }
Property Value
RadTreeViewItem

DropTargetTree

Gets the RadTreeView under the drop point. Initialized when drop operation completes. This property will be null if the drop is executed over RadTreeViewItem or outside RadTreeView.

Declaration
public RadTreeView DropTargetTree { get; set; }
Property Value
RadTreeView

Methods

SetDraggedItems(IEnumerable<Object>)

Sets the dragged items.

Declaration
public void SetDraggedItems(IEnumerable<object> draggedItems)
Parameters
System.Collections.Generic.IEnumerable<System.Object> draggedItems

UpdateDragVisual()

Updates the DragVisual property value in case it is a TreeViewDragVisual instance.

Declaration
public void UpdateDragVisual()

Extension Methods