ToolStripItem.DragDrop Event

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when the user drags an item and the user releases the mouse button, indicating that the item should be dropped into this item.

public:
 event System::Windows::Forms::DragEventHandler ^ DragDrop;

[System.ComponentModel.Browsable(false)]
public event System.Windows.Forms.DragEventHandler DragDrop;

[System.ComponentModel.Browsable(false)]
public event System.Windows.Forms.DragEventHandler? DragDrop;

[<System.ComponentModel.Browsable(false)>]
member this.DragDrop : System.Windows.Forms.DragEventHandler

Public Custom Event DragDrop As DragEventHandler

Event Type

DragEventHandler

Attributes: BrowsableAttribute

Examples

The following code example shows how to convert the X and Y properties to a client Point. This code example is part of a larger example provided for the ToolStripRenderer class.

// This method defines the DragOver event behavior. 
protected override void OnDragOver(DragEventArgs dea)
{
    base.OnDragOver(dea);

    // Get the ToolStripButton control 
    // at the given mouse position.
    Point p = new Point(dea.X, dea.Y);
    ToolStripButton item = this.GetItemAt(
        this.PointToClient(p)) as ToolStripButton;

    // If the ToolStripButton control is the empty cell,
    // indicate that the move operation is valid.
    if( item == this.emptyCellButton )
    {
        // Set the drag operation to indicate a valid move.
        dea.Effect = DragDropEffects.Move;
    }
}

' This method defines the DragOver event behavior. 
Protected Overrides Sub OnDragOver(dea As DragEventArgs)
   MyBase.OnDragOver(dea)
   
   ' Get the ToolStripButton control 
   ' at the given mouse position.
   Dim p As New Point(dea.X, dea.Y)
   Dim item As ToolStripButton = CType(Me.GetItemAt(Me.PointToClient(p)), ToolStripButton)
   
   
   ' If the ToolStripButton control is the empty cell,
   ' indicate that the move operation is valid.
     If item Is Me.emptyCellButton Then
         ' Set the drag operation to indicate a valid move.
         dea.Effect = DragDropEffects.Move
     End If
 End Sub

Remarks

The X and Y properties of the DragEventArgs are in screen coordinates, not client coordinates. For more information about handling events, see Handling and Raising Events.

Applies to

Share via