ItemDragEventArgs.Button Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value that indicates which mouse buttons were pressed during the drag operation.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public MouseButtons Button { get; }

Property Value

Type: System.Windows.Forms.MouseButtons

A bitwise combination of MouseButtons values.

This property enables you to determine which mouse buttons were pressed during a drag-and-drop operation. The value of this property can be used to properly determine how the drag-and drop-operation should be performed. For example, you might want to move an item to a new location when the left mouse button is pressed, and copy it to the new location when the right mouse button is pressed.

The following example illustrates the use of the ItemDragEventArgs class when you enable 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 if (e.Button == MouseButtons.Right)
    {
        DoDragDrop(e.Item, DragDropEffects.Copy);
    }
}

.NET Framework
Available since 1.1
Return to top
Show: