ToolStripItem.DragEnter イベントとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ToolStripItem.DragEnter イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

この項目のクライアント領域に対し、ユーザーが項目をドラッグしたときに発生します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Event DragEnter As
 DragEventHandler

Visual Basic (使用法)

Dim instance As ToolStripItem
Dim handler As DragEventHandler

AddHandler instance.DragEnter, handler

public event DragEventHandler DragEnter

C++

public:
event DragEventHandler^ DragEnter {
    void add (DragEventHandler^ value);
    void remove (DragEventHandler^ value);
}

/** @event */
public void add_DragEnter (DragEventHandler
 value)

/** @event */
public void remove_DragEnter (DragEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

DragEnter イベントは、ユーザーがドラッグアンドドロップ操作中、最初にマウスカーソルを項目上にドラッグすると発生します。

DoDragDrop メソッドは、現在のカーソル位置のアイテムを判別します。次に、アイテムが有効なドロップターゲットかどうかを確認します。

項目が有効なドロップターゲットの場合、指定したドラッグアンドドロップの効果が付いた状態で GiveFeedback イベントが発生します。ドラッグアンドドロップ効果の一覧については、DragDropEffects 列挙体を参照してください。

マウスカーソルの位置、キーボードの状態、およびマウスボタンの状態の変更は、次の方法で監視されます。

ユーザーがウィンドウの外に移動した場合、DragLeave イベントが生成されます。
マウスが別の項目に移動した場合は、そのコントロールの DragEnter が生成されます。
マウスが移動しても同じ項目内の場合は、DragOver イベントが生成されます。

キーボードまたはマウスボタンの状態に変更があった場合、QueryContinueDrag イベントが生成され、このイベントの QueryContinueDragEventArgs の Action プロパティの値に応じて、ドラッグを継続するか、データをドロップするか、操作をキャンセルするかが判断されます。

DragAction の値が Continue の場合、操作を継続するための DragOver イベントが生成され、適切な視覚的フィードバックを設定できるように新しい効果による GiveFeedback イベントが生成されます。有効なドロップ効果の一覧については、DragDropEffects 列挙体を参照してください。

DragOver イベントおよび GiveFeedback イベントはペアになっています。したがって、次のように、マウスがドロップターゲットをまたがって移動した場合、マウスの位置に関する最新のフィードバックがユーザーに提示されます。

DragAction の値が Drop の場合、ドロップ効果の値がソースに返されます。ソースアプリケーションでは、ソースデータに対して適切な操作を実行できます。たとえば、移動操作だった場合は、データの切り取りなどを実行できます。
DragAction の値が Cancel の場合、DragLeave イベントが生成されます。

メモ
DragEventArgs の X プロパティおよび Y プロパティは、クライアント座標ではなく、画面座標の値です。

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

X プロパティおよび Y プロパティをクライアントの Point に変換する方法を次のコード例に示します。このコード例は、ToolStripRenderer クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' 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

// 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;
    }
}