Interface
IDragDropBehavior<TState>

The base class for drag-drop operation behaviors.

Definition

Namespace:Telerik.Windows.DragDrop.Behaviors

Assembly:Telerik.Windows.Controls.dll

Type Parameters:

TState

Syntax:

cs-api-definition
public interface IDragDropBehavior<TState>

Methods

CanDrop(TState)

Gets the value specifying whether the drag operation can be completed, or not.

Declaration

cs-api-definition
bool CanDrop(TState state)

Parameters

state

TState

DragDropState identifying the current drag operation.

Returns

bool

True when the drag operation can be finished, otherwise false.

Remarks

This method is called on every mouse move. All properties in the DragDropState are valid.

CanStartDrag(TState)

Gets the value specifying whether the drag operation can be started, or not.

Declaration

cs-api-definition
bool CanStartDrag(TState state)

Parameters

state

TState

DragDropState that provides context for the current operation.

Returns

bool

True when the drag operation can be started, otherwise false.

Remarks

This method is called only when the drag operation initiated.

CoerceDraggedItems(TState)

When overridden in a derived class, filters the dragged items collection if necessary.

Declaration

cs-api-definition
IEnumerable CoerceDraggedItems(TState state)

Parameters

state

TState

DragDropState that provides context for the current operation.

Returns

IEnumerable

The filtered dragged items.

Remarks

This method is called immediately before the drag operation starts. Only the Items property of the DragDropState is valid.

DragDropCanceled(TState)

When overridden in a derived class cleans up a cancelled drag operation. This method is called only in the context of the drag source control.

Declaration

cs-api-definition
void DragDropCanceled(TState state)

Parameters

state

TState

DragDropState that provides context for the current operation.

Remarks

This method is called only when the drag operation is cancelled by the user. If this method is called, the source's DragDropCompleted and target's Drop methods are not called.

DragDropCompleted(TState)

When overridden in a derived class completes the drag operation. This method is called only in the context of the drag source control.

Declaration

cs-api-definition
void DragDropCompleted(TState state)

Parameters

state

TState

DragDropState that provides context for the current operation.

Remarks

When the drag source and the drop target are the same control, this method is called after Drop. This method is called only when the drag operation completed successfully. If this method is called, DragDropCanceled is not called.

Drop(TState)

When overridden in a derived class completes the drop operation. This method is called only in the context of the drop target control.

Declaration

cs-api-definition
void Drop(TState state)

Parameters

state

TState

DragDropState that provides context for the current operation.

Remarks

When the drag source and the drop target are the same control, this method is called before DragCompleted.