DragObjectStartEventArgs.DragObject Property

Gets the column or band whose header is about to be dragged.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.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 is about to be dragged.

Remarks

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-multiple-columns-in-a-grid-at-once-e3385/CS/WindowsApplication3/MultiColumnsDragProvider.cs#L119

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

VB.NET

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

Private Sub OnDragObjectStart(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs)
    Dim column As GridColumn = TryCast(e.DragObject, GridColumn)
    If Not CanDrag(column, e.Allow) Then