ItemDragEventArgs.Item Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets the item that is being dragged.

public:
 property System::Object ^ Item { System::Object ^ get(); };

public object? Item { get; }

member this.Item : obj

Public ReadOnly Property Item As Object

Property Value

Object

An object that represents the item being dragged.

Examples

The following example illustrates the use of ItemDragEventArgs when enabling drag-and-drop operations within a TreeView control. The Button property determines whether the dragged node should be moved or copied to its destination. The node, represented by the Item property, is then passed to the TreeView control's DoDragDrop method along with a value that indicates the desired effect of the drag-and-drop operation.

For the complete example, see the TreeView.ItemDrag reference topic.

private:
   void treeView1_ItemDrag( Object^ /*sender*/, ItemDragEventArgs^ e )
   {
      
      // Move the dragged node when the left mouse button is used.
      if ( e->Button == ::MouseButtons::Left )
      {
         DoDragDrop( e->Item, DragDropEffects::Move );
      }
      // Copy the dragged node when the right mouse button is used.
      else
      
      // Copy the dragged node when the right mouse button is used.
      if ( e->Button == ::MouseButtons::Right )
      {
         DoDragDrop( e->Item, DragDropEffects::Copy );
      }
   }

private void treeView1_ItemDrag(object sender, ItemDragEventArgs e)
{
    // Move the dragged node when the left mouse button is used.
    if (e.Button == MouseButtons.Left)
    {
        DoDragDrop(e.Item, DragDropEffects.Move);
    }

    // Copy the dragged node when the right mouse button is used.
    else if (e.Button == MouseButtons.Right)
    {
        DoDragDrop(e.Item, DragDropEffects.Copy);
    }
}

Private Sub treeView1_ItemDrag(ByVal sender As Object, ByVal e As ItemDragEventArgs)

    ' Move the dragged node when the left mouse button is used.
    If e.Button = MouseButtons.Left Then
        DoDragDrop(e.Item, DragDropEffects.Move)

    ' Copy the dragged node when the right mouse button is used.
    ElseIf e.Button = MouseButtons.Right Then
        DoDragDrop(e.Item, DragDropEffects.Copy)
    End If
End Sub

Remarks

You can use this property to determine which item from the TreeView or ListView controls is being dragged from the control.