Control.DragEnter イベント

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

Control.DragEnter イベント

オブジェクトがコントロールの境界内にドラッグされると発生します。

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

Visual Basic (宣言)

Public Event DragEnter As
 DragEventHandler

Visual Basic (使用法)

Dim instance As Control
Dim handler As DragEventHandler

AddHandler instance.DragEnter, handler

C#

public event DragEventHandler DragEnter

C++

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

J#

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

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

JScript

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

解説

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

メモ
Microsoft .NET Framework version 2.0 より前のバージョンでは、DragEnter イベントと DragDrop イベントを備えた UserControl を Windows フォーム上に配置し、デザイン時にその UserControl に対して、なんらかのデータをドラッグ アンド ドロップした場合、DropDrop イベントと DropEnter イベントが発生します。ただし、ソリューションを一度閉じてから再び開くと、DragEnter イベントと DragDrop イベントは発生しなくなります。

ドラッグ アンド ドロップ操作関連のイベントがどのように、いつ発生するかについて次に示します。

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

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

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

• ユーザーがウィンドウの外に移動した場合、DragLeave イベントが生成されます。

• マウスが別のコントロールに移動した場合は、そのコントロールの DragEnter が生成されます。

• マウスが移動しても同じコントロール内の場合は、DragOver イベントが生成されます。

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

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

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

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

• DragAction の値が Cancel の場合、DragLeave イベントが生成されます。

  メモ
  DragEventArgs の X プロパティおよび Y プロパティは、クライアント座標ではなく、画面座標の値です。次の Visual C# のコードでは、これらのプロパティをクライアントの Point に変換します。

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

使用例

2 つの ListBox コントロールの間でドラッグ アンド ドロップ操作を実行するコード例を次に示します。この例では、ドラッグ アクションが開始したときに DoDragDrop メソッドが呼び出されます。ドラッグ操作は、MouseDown イベント実行中のマウス位置から SystemInformation.DragSize を超えてマウスが移動したときに開始されます。IndexFromPoint メソッドは、MouseDown イベントで、ドラッグする項目のインデックスを判別するために使用します。

この例では、ドラッグ アンド ドロップ操作でカスタム カーソルを使用する方法についても示します。この例では、2 つのカーソル ファイル (3dwarro.cur と 3dwno.cur) がアプリケーション ディレクトリ内に存在している必要があります。なお、それぞれのファイルはドラッグ用のカスタム カーソルとドロップなしのカスタム カーソルを表します。カスタム カーソルは、UseCustomCursorsCheckCheckBox がオンになっている場合に使用されます。カスタム カーソルは、GiveFeedback イベント ハンドラで設定されます。

キーボードの状態は、右側の ListBox の DragOver イベント ハンドラで評価されます。ドラッグ操作の内容は、Shift キー、Ctrl キー、Alt キー、または Ctrl + Alt キーの状態によって決まります。ドロップが発生する ListBox 内の位置は、DragOver イベント時にも判定されます。ドロップするデータが String でない場合は、DragEventArgs.Effect が DragDropEffects で None に設定されます。最後に、ドロップのステータスが DropLocationLabelLabel に表示されます。

右側の ListBox にドロップするデータは、DragDrop イベント ハンドラで判定されます。また、String 値が ListBox の該当する場所に追加されます。ドラッグ操作がフォームの範囲を超えて移動した場合、ドラッグ アンド ドロップ操作は QueryContinueDrag イベント ハンドラでキャンセルされます。

DragEnter イベントの使用方法を次のコード例に示します。コード例全体については、DoDragDrop メソッドのトピックを参照してください。

Visual Basic

Private Sub ListDragTarget_DragEnter(ByVal
 sender As Object, ByVal
 e As DragEventArgs) Handles ListDragTarget.DragEnter

    ' Reset the label text.
    DropLocationLabel.Text = "None"
End Sub

C#

private void ListDragTarget_DragEnter(object
 sender, System.Windows.Forms.DragEventArgs e) {
    // Reset the label text.
    DropLocationLabel.Text = "None";
}

C++

void ListDragTarget_DragEnter( Object^ /*sender*/, System::Windows::Forms::DragEventArgs^
 /*e*/ )
{
   // Reset the label text.
   DropLocationLabel->Text = "None";
}

J#

private void listDragTarget_DragEnter(Object
 sender, 
    System.Windows.Forms.DragEventArgs e)
{
    // Reset the label text.
    dropLocationLabel.set_Text("None");
} //listDragTarget_DragEnter

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
Control クラス
Control メンバ
System.Windows.Forms 名前空間
OnDragEnter