DragOverGridEventArgs.GetDragOverGridEventArgs(DragOverEventArgs) Method

Calculates grid-specific event arguments.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public static DragOverGridEventArgs GetDragOverGridEventArgs(
    DragOverEventArgs e
)

VB.NET

Public Shared Function GetDragOverGridEventArgs(
    e As DragOverEventArgs
) As DragOverGridEventArgs

Parameters

Name	Type	Description
e	DragOverEventArgs	An object that contains event arguments.

Returns

Type	Description
DragOverGridEventArgs	An object that contains grid-specific event arguments.

Example

The example below shows how to copy data from a tree list to a grid.

C#

using DevExpress.Utils.DragDrop;

//The code below assumes that you are moving data from a tree list to a grid.
//Create new grid rows, and populate them with data from tree list nodes.
private void dragDropEvents1_DragDrop(object sender, DragDropEventArgs e) {
    List<TreeListNode> list = e.Data as List<TreeListNode>;
    foreach (TreeListNode node in list) {
        gridView1.AddNewRow();
        gridView1.SetRowCellValue(GridControl.NewItemRowHandle, gridView1.Columns["DEPARTMENT"], node.GetValue(colDEPARTMENT1));
    }
    e.Handled = true;
}

VB.NET

Imports DevExpress.Utils.DragDrop

'The code below assumes that you are moving data from a tree list to a grid.
'Create new grid rows, and populate them with data from tree list nodes.
Private Sub dragDropEvents1_DragDrop(ByVal sender As Object, ByVal e As DevExpress.Utils.DragDrop.DragDropEventArgs) _
    Handles dragDropEvents1.DragDrop
    Dim list As List(Of TreeListNode) = TryCast(e.Data, List(Of TreeListNode))
    For Each node As TreeListNode In list
        gridView1.AddNewRow()
        gridView1.SetRowCellValue(GridControl.NewItemRowHandle, gridView1.Columns("DEPARTMENT"), node.GetValue(colDEPARTMENT1))
    Next node
    e.Handled = True
End Sub

Note

When you handle the DragDrop event for a grid view, use the static (Shared in VB) DragDropGridEventArgs.GetDragDropGridEventArgs method to calculate arguments specific to the grid view.

C#

using DevExpress.Utils.DragDrop;
using DevExpress.XtraGrid.Views.Grid;

dragDropEvents1.DragDrop += Behavior_DragDrop;

private void Behavior_DragDrop(object sender, DragDropEventArgs e) {
   DragDropGridEventArgs args = DragDropGridEventArgs.GetDragDropGridEventArgs(e);
   //You can also cast DragDropEventArgs to DragDropGridEventArgs.
   //DragDropGridEventArgs args = (DragDropGridEventArgs)e;
}

VB.NET

Imports DevExpress.Utils.DragDrop
Imports DevExpress.XtraGrid.Views.Grid

AddHandler DragDropEvents1.DragDrop, AddressOf Behavior_DragDrop
Private Sub Behavior_DragDrop(ByVal sender As Object, ByVal e As DragDropEventArgs)
   Dim args As DragDropGridEventArgs = DragDropGridEventArgs.GetDragDropGridEventArgs(e)
   'You can also cast DragDropEventArgs to DragDropGridEventArgs.
   'Dim args As DragDropGridEventArgs = CType(e, DragDropGridEventArgs)
End Sub

Note

Run the XtraTreeList or XtraGrid demo and click Open Solution for more examples.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDragOverGridEventArgs(DragOverEventArgs) method.

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#

winforms-grid-reorder-rows-drag-drop/CS/E764/Form1.cs#L52

private void Behavior_DragOver(object sender, DragOverEventArgs e) {
    DragOverGridEventArgs args = DragOverGridEventArgs.GetDragOverGridEventArgs(e);
    e.InsertType = args.InsertType;

VB.NET

winforms-grid-reorder-rows-drag-drop/VB/E764/Form1.vb#L59

Private Sub Behavior_DragOver(ByVal sender As Object, ByVal e As DragOverEventArgs)
    Dim args As DragOverGridEventArgs = DragOverGridEventArgs.GetDragOverGridEventArgs(e)
    e.InsertType = args.InsertType