DragObjectOverEventArgs.DragObject Property

Gets the column or band whose header is being dragged.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public object DragObject { get; }

VB.NET

Public ReadOnly Property DragObject As Object

Property Value

Type	Description
Object	An object representing the column or band whose header has been dropped.

Remarks

If a column header is being dragged, the property returns either a GridColumn or BandedGridColumn object depending upon View type. If a band header is being dragged, the property returns a GridBand object.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DragObject 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-drag-fields-from-the-gridview-to-pivotgridcontrol-e2089/CS/Q250992/Main.cs#L29

Point location = MousePosition;
if (!(e.DragObject is GridColumn)) return;
e.DropInfo.Valid = GetChildAtPoint(PointToClient(location)) != pivot;

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

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

how-to-drag-multiple-columns-in-a-grid-at-once-e3385/CS/WindowsApplication3/MultiColumnsDragProvider.cs#L126

{
    GridColumn column = e.DragObject as GridColumn;
    if (!CanDrag(column, e.DropInfo.Valid)) return;

VB.NET

how-to-drag-fields-from-the-gridview-to-pivotgridcontrol-e2089/VB/Q250992/Main.vb#L35

Dim location As Point = MousePosition
If Not (TypeOf e.DragObject Is GridColumn) Then
    Return

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

Private Sub myGridView2_DragObjectOver(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs) Handles myGridView1.DragObjectOver, myGridView2.DragObjectOver
    If TypeOf e.DragObject Is GridColumn AndAlso (CType(e.DragObject, GridColumn)).View IsNot sender Then
        e.DropInfo.Valid = Not((TryCast(e.DropInfo, ColumnPositionInfo)).InGroupPanel OrElse ((TryCast(sender, GridView)).VisibleColumns.Count > 0))

how-to-drag-multiple-columns-in-a-grid-at-once-e3385/VB/WindowsApplication3/MultiColumnsDragProvider.vb#L114

Private Sub OnViewDragObjectOver(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs)
    Dim column As GridColumn = TryCast(e.DragObject, GridColumn)
    If Not CanDrag(column, e.DropInfo.Valid) Then