DXDragEventArgs.Data Property

Gets or sets the data elements being dragged.

Namespace: DevExpress.Utils.DragDrop

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

public object Data { get; }

VB.NET

Public ReadOnly Property Data As Object

Property Value

Type	Description
Object	An object that specifies the data elements being dragged.

Remarks

The actual data type depends on the source control.

• For a grid control - an array of row handles.

  // The source control is a grid.
  int[] rowHandles = e.Data as int[];
  int[] rowHandles1 = e.GetData<int[]>();
  

• For a tree list - a list of the nodes.

  // The source is a tree list.
  List<TreeListNode> nodeList = e.Data as List<TreeListNode>;
  List<TreeListNode> nodeList1 = e.GetData<List<TreeListNode>>();
  

• For a list box control - a list of the list box items.

  // The source control is a list box.
  List<object> items = e.Data as List<object>;
  List<object> items1 = e.GetData<List<object>>();
  // If the list box is not bound to a data source (see the Items property),
  // the event argument contains string representations of data items.
  string item0 = items[0] as string;
  // If the list box is bound to a data source (see the DataSource property),
  // the actual type depends on the data source.
  DataRowView dataRowView0 = items[0] as DataRowView;
  

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Data 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#

winforms-grid-drag-and-drop-selected-rows/CS/Form1.cs#L37

private void ListBoxBehavior_DragDrop(object sender, DragDropEventArgs e) {
    int[] rowHandles = (int[])e.Data;
    object[] rows = GetRows(this.gridView1, rowHandles);

VB.NET

winforms-grid-drag-and-drop-selected-rows/VB/Form1.vb#L45

Private Sub ListBoxBehavior_DragDrop(ByVal sender As Object, ByVal e As DragDropEventArgs)
    Dim rowHandles As Integer() = CType(e.Data, Integer())
    Dim rows As Object() = GetRows(gridView1, rowHandles)