DragObjectDropEventArgs.Canceled Property

Gets whether the dragged header has been dropped successfully.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public bool Canceled { get; }

VB.NET

Public ReadOnly Property Canceled As Boolean

Property Value

Type	Description
Boolean	true if the drag and drop operation was cancelled; otherwise, false.

Remarks

The property returns false if drag and drop was performed successfully and the dragged column or band header was moved to another position. Dragging doesn’t end successfully if the end-user tried to move the header to an invalid target position or if dragging was cancelled by pressing the ESC key or the right mouse button. You can also prohibit dropping to a specific position by handling the GridView.DragObjectOver event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Canceled property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/CS/Form1.cs#L25

{
    if (e.DropInfo.Valid && !e.Canceled && e.DragObject is GridColumn && ((GridColumn)e.DragObject).View != sender)
    {

VB.NET

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/VB/Form1.vb#L27

Private Sub myGridView2_DragObjectDrop(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs) Handles myGridView1.DragObjectDrop, myGridView2.DragObjectDrop
    If e.DropInfo.Valid AndAlso (Not e.Canceled) AndAlso TypeOf e.DragObject Is GridColumn AndAlso (CType(e.DragObject, GridColumn)).View IsNot sender Then
        TryCast(sender, GridView).BeginUpdate()