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

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

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

Control.DragDrop イベント

ドラッグアンドドロップ操作が完了したときに発生します。

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

Visual Basic (宣言)

Public Event DragDrop As
 DragEventHandler

Visual Basic (使用法)

Dim instance As Control
Dim handler As DragEventHandler

AddHandler instance.DragDrop, handler

public event DragEventHandler DragDrop

C++

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

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

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

JScript

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

解説

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

Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y));

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

メモ

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

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

使用例

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 イベントハンドラでキャンセルされます。

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

Visual Basic

Private Sub ListDragTarget_DragDrop(ByVal
 sender As Object, ByVal
 e As DragEventArgs) Handles ListDragTarget.DragDrop
    ' Ensures that the list item index is contained in the data.

    If (e.Data.GetDataPresent(GetType(System.String)))
 Then

        Dim item As Object
 = CType(e.Data.GetData(GetType(System.String)), System.Object)

        ' Perform drag-and-drop, depending upon the effect.
        If (e.Effect = DragDropEffects.Copy Or
 _
            e.Effect = DragDropEffects.Move) Then

            ' Insert the item.
            If (indexOfItemUnderMouseToDrop <> ListBox.NoMatches)
 Then
                ListDragTarget.Items.Insert(indexOfItemUnderMouseToDrop, item)
            Else
                ListDragTarget.Items.Add(item)

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

private void ListDragTarget_DragDrop(object
 sender, System.Windows.Forms.DragEventArgs e) 
{
    // Ensure that the list item index is contained in the data.
    if (e.Data.GetDataPresent(typeof(System.String))) {

        Object item = (object)e.Data.GetData(typeof(System.String));

        // Perform drag-and-drop, depending upon the effect.
        if (e.Effect == DragDropEffects.Copy ||
            e.Effect == DragDropEffects.Move) {
        
            // Insert the item.
            if (indexOfItemUnderMouseToDrop != ListBox.NoMatches)
                ListDragTarget.Items.Insert(indexOfItemUnderMouseToDrop, item);
            else
                ListDragTarget.Items.Add(item);
            
        }
    }
    // Reset the label text.
    DropLocationLabel.Text = "None";
}

C++

void ListDragTarget_DragDrop( Object^ /*sender*/, System::Windows::Forms::DragEventArgs^
 e )
{
   // Ensure that the list item index is contained in the data.
   if ( e->Data->GetDataPresent( System::String::typeid
 ) )
   {
      Object^ item = dynamic_cast<Object^>(e->Data->GetData( System::String::typeid
 ));
      
      // Perform drag-and-drop, depending upon the effect.
      if ( e->Effect == DragDropEffects::Copy || e->Effect
 == DragDropEffects::Move )
      {
         // Insert the item.
         if ( indexOfItemUnderMouseToDrop != ListBox::NoMatches
 )
                        ListDragTarget->Items->Insert( indexOfItemUnderMouseToDrop,
 item );
         else
                        ListDragTarget->Items->Add( item );
      }
   }

   // Reset the label text.
   DropLocationLabel->Text = "None";
}

private void listDragTarget_DragDrop(Object
 sender, 
    System.Windows.Forms.DragEventArgs e)
{
    // Ensure that the list item index is contained in the data.
    if (e.get_Data().GetDataPresent(String.class.ToType()))
 {
        Object item = (Object)(e.get_Data().GetData(
               String.class.ToType()));
        // Perform drag-and-drop, depending upon the effect.
        if (e.get_Effect().Equals(DragDropEffects.Copy) || 
            e.get_Effect().Equals(DragDropEffects.Move)) {
            // Insert the item.
            if (indexOfItemUnderMouseToDrop != ListBox.NoMatches)
 {
                listDragTarget.get_Items().Insert(
                    indexOfItemUnderMouseToDrop, item);
            }
            else {
                listDragTarget.get_Items().Add(item);
            }
        }
    }
    // Reset the label text.
    dropLocationLabel.set_Text("None");
} //listDragTarget_DragDrop