TileView.BeforeItemDrag Event

Fires when a tile drag operation is about to be started. Allows you to provide a drag image, or to cancel the operation. This event does not fire when you enable drag-and-drop using Drag And Drop Behavior.

Namespace: DevExpress.XtraGrid.Views.Tile

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DXCategory("Action")]
public event TileViewBeforeItemDragEventHandler BeforeItemDrag
<DXCategory("Action")>
Public Event BeforeItemDrag As TileViewBeforeItemDragEventHandler

Event Data

The BeforeItemDrag event's data class is BeforeItemDragEventArgs. The following properties provide information specific to this event:

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
DragImage Gets or sets the image that represents the tile during the drag-and-drop operation.
RowHandle Gets the row handle that identifies the current tile.

Remarks

Use the TileView.OptionsDragDrop.AllowDrag setting to enable the built-in tile drag-and-drop feature.

The BeforeItemDrag event fires when a drag operation is initiated by an end-user. The event allows you to do the following:

  • Prevent the drag operation from starting, by setting the event's Cancel parameter to true.
  • Provide a custom drag image for the drag operation with the event's DragImage parameter. Initially, this parameter contains the default drag image, which was created from the tile being dragged.
See Also