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.

Definition

Namespace:Telerik.Windows.Controls.TreeView

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

cs-api-definition
public class TreeViewDragDropOptions

Inheritance: objectTreeViewDragDropOptions

Constructors

TreeViewDragDropOptions()

Initializes a new instance of the TreeViewDragDropOptions class.

Declaration

cs-api-definition
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

cs-api-definition
public static readonly string Key

Field Value

string

Properties

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

cs-api-definition
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

cs-api-definition
public object DragVisual { get; set; }

Property Value

object

DraggedItems

Get the dragged items.

Declaration

cs-api-definition
public IEnumerable<object> DraggedItems { get; }

Property Value

IEnumerable<object>

DropAction

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

Declaration

cs-api-definition
public DropAction DropAction { get; set; }

Property Value

DropAction

DropPosition

Gets or sets the drop position of dragged items.

Declaration

cs-api-definition
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

cs-api-definition
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

cs-api-definition
public RadTreeView DropTargetTree { get; set; }

Property Value

RadTreeView

Methods

SetDraggedItems(IEnumerable<object>)

Sets the dragged items.

Declaration

cs-api-definition
public void SetDraggedItems(IEnumerable<object> draggedItems)

Parameters

draggedItems

IEnumerable<object>

UpdateDragVisual()

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

Declaration

cs-api-definition
public void UpdateDragVisual()