DragObjectStartEventArgs Class

Provides data for the GridView.DragObjectStart event.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

public class DragObjectStartEventArgs :
    EventArgs

VB.NET

Public Class DragObjectStartEventArgs
    Inherits EventArgs

Related API Members

DragObjectStartEventArgs is the data class for the following events:

• GridView.DragObjectStart

Remarks

The GridView.DragObjectStart event is raised when end-users attempt to drag a column header or band header. It enables you to identify the element which is about to be dragged and cancel dragging, if needed. The DragObjectStartEventArgs class introduces the DragObjectStartEventArgs.DragObject and DragObjectStartEventArgs.Allow properties for this purpose.

Related GitHub Examples

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

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#L117

void OnDragObjectStart(object sender, DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs e)
{

VB.NET

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

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

Inheritance

Object

EventArgs

DragObjectStartEventArgs