Class DragDropOptions

An object that holds information about the current drag/drop operation.

Inheritance
System.Object
DragDropOptions
Namespace: Telerik.Windows.Controls.DragDrop
Assembly: Telerik.Windows.Controls.dll

Syntax

public class DragDropOptions : Object
Remarks

Used for giving information about and customizing a drag/drop operation.

Constructors

DragDropOptions()

Declaration
public DragDropOptions()

Properties

ArrowCue

Gets or sets the arrow that will appear during dragging.

Declaration
public ContentControl ArrowCue { get; set; }
Property Value
System.Windows.Controls.ContentControl

Remarks

The SourceCue can only be changed during the DragQuery stage.

CurrentCursor

Gets or sets the current mouse cursor while performing drag operation.

Declaration
public Cursor CurrentCursor { get; set; }
Property Value
System.Windows.Input.Cursor

CurrentDragPoint

Gets the point where the mouse is relative to the root canvas.

Declaration
public Point CurrentDragPoint { get; }
Property Value
System.Windows.Point

Destination

Gets the element that has registered the AllowDrop.

Declaration
public FrameworkElement Destination { get; set; }
Property Value
System.Windows.FrameworkElement

DestinationCue

The element that will replace the DestinationCueHost during drag/drop.

Declaration
public ContentControl DestinationCue { get; set; }
Property Value
System.Windows.Controls.ContentControl

DestinationCueHost

The object that will be replaced with the DestinationCue in a successful drag over.

Declaration
public FrameworkElement DestinationCueHost { get; set; }
Property Value
System.Windows.FrameworkElement

DragCue

Gets or sets the element that will be dragged visually.

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

Remarks

The SourceCue can only be changed during the DragQuery stage.

MouseClickPoint

Gets the point where the mouse was first pressed relative to the root canvas.

Declaration
public Point MouseClickPoint { get; }
Property Value
System.Windows.Point

ParticipatingVisualRoots

Gets a collection with the visual roots what will participate in the drag/drop operation but are not descendants of the application root visual.

Declaration
public IList<UIElement> ParticipatingVisualRoots { get; }
Property Value
System.Collections.Generic.IList<System.Windows.UIElement>

Remarks

All popups that should participate in the drag/drop should be added in this collection.

Payload

Gets or sets the data object that is transferred in the drag/drop operation.

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

Remarks

The Payload can only be set during the DragQuery stage of DragQuery.

RelativeDragPoint

Gets the point where the mouse is relative to the destination element.

Declaration
public Point RelativeDragPoint { get; }
Property Value
System.Windows.Point

Source

Gets the source that has registered with AllowDrag.

Declaration
public FrameworkElement Source { get; }
Property Value
System.Windows.FrameworkElement

SourceCue

Gets or sets the element that will replace the SourceCueHost.

Declaration
public ContentControl SourceCue { get; set; }
Property Value
System.Windows.Controls.ContentControl

Remarks

The SourceCue can only be changed during the DragQuery stage.

SourceCueHost

Gets or sets the element that will be replaced with the source cue during dragging.

Declaration
public FrameworkElement SourceCueHost { get; set; }
Property Value
System.Windows.FrameworkElement

Remarks

The SourceCue can only be changed during the DragQuery stage.

Status

Gets the current status of the drag and drop operation.

Declaration
public DragStatus Status { get; }
Property Value
DragStatus

Extension Methods