DragEventArgs クラス

[アーティクル]
03/28/2008

DragDrop イベント、 DragEnter イベント、または DragOver イベントのデータを提供します。

この型のすべてのメンバの一覧については、DragEventArgs メンバを参照してください。

System.Object
System.EventArgs
System.Windows.Forms.DragEventArgs

<ComVisible(True)>
Public Class DragEventArgs   Inherits EventArgs
[C#]
[ComVisible(true)]
public class DragEventArgs : EventArgs
[C++]
[ComVisible(true)]
public __gc class DragEventArgs : public EventArgs
[JScript]
public
   ComVisible(true)
class DragEventArgs extends EventArgs

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

ユーザーが、オブジェクトをコントロールの上にドラッグし、マウスボタンを離してオブジェクトをコントロールにドロップしてドラッグアンドドロップ操作を完了すると、 DragDrop イベントが発生します。ユーザーがマウスを使ってオブジェクトをドラッグしている間に、マウスポインタがコントロール内に入ってくると、 DragEnter イベントが発生します。ユーザーがマウスを使ってオブジェクトをドラッグしている間に、マウスポインタがコントロール内を移動すると、 DragOver イベントが発生します。

DragEventArgs オブジェクトはこのイベントに関連付けられているデータ、Shift、Ctrl、Alt の各キーの状態、マウスポインタの位置、ドラッグイベントのソースとターゲットで可能なドラッグアンドドロップ効果などを指定します。

イベントモデルの詳細については、「イベントとデリゲート」を参照してください。

使用例

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

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

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

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

[Visual Basic, C#, C++] DragEventArgs クラスの使用方法を次のコード例に示します。コード例全体については、 DoDragDrop メソッドのトピックを参照してください。

 
Private Sub ListDragTarget_DragOver(ByVal sender As Object, ByVal e As DragEventArgs) Handles ListDragTarget.DragOver
    ' Determine whether string data exists in the drop data. If not, then
    ' the drop effect reflects that the drop cannot occur.
    If Not (e.Data.GetDataPresent(GetType(System.String))) Then

        e.Effect = DragDropEffects.None
        DropLocationLabel.Text = "None - no string data."
        Return
    End If

    ' Set the effect based upon the KeyState.
    If ((e.KeyState And (8 + 32)) = (8 + 32) And _
        (e.AllowedEffect And DragDropEffects.Link) = DragDropEffects.Link) Then
        ' KeyState 8 + 32 = CTL + ALT

        ' Link drag and drop effect.
        e.Effect = DragDropEffects.Link

    ElseIf ((e.KeyState And 32) = 32 And _
        (e.AllowedEffect And DragDropEffects.Link) = DragDropEffects.Link) Then

        ' ALT KeyState for link.
        e.Effect = DragDropEffects.Link

    ElseIf ((e.KeyState And 4) = 4 And _
        (e.AllowedEffect And DragDropEffects.Move) = DragDropEffects.Move) Then

        ' SHIFT KeyState for move.
        e.Effect = DragDropEffects.Move

    ElseIf ((e.KeyState And 8) = 8 And _
        (e.AllowedEffect And DragDropEffects.Copy) = DragDropEffects.Copy) Then

        ' CTL KeyState for copy.
        e.Effect = DragDropEffects.Copy

    ElseIf ((e.AllowedEffect And DragDropEffects.Move) = DragDropEffects.Move) Then

        ' By default, the drop action should be move, if allowed.
        e.Effect = DragDropEffects.Move

    Else
        e.Effect = DragDropEffects.None
    End If

    ' Gets the index of the item the mouse is below. 

    ' The mouse locations are relative to the screen, so they must be 
    ' converted to client coordinates.

    indexOfItemUnderMouseToDrop = _
        ListDragTarget.IndexFromPoint(ListDragTarget.PointToClient(New Point(e.X, e.Y)))

    ' Updates the label text.
    If (indexOfItemUnderMouseToDrop <> ListBox.NoMatches) Then

        DropLocationLabel.Text = "Drops before item #" & (indexOfItemUnderMouseToDrop + 1)
    Else
        DropLocationLabel.Text = "Drops at the end."
    End If

End Sub

[C#] 
private void ListDragTarget_DragOver(object sender, System.Windows.Forms.DragEventArgs e) 
{

    // Determine whether string data exists in the drop data. If not, then
    // the drop effect reflects that the drop cannot occur.
    if (!e.Data.GetDataPresent(typeof(System.String))) {

        e.Effect = DragDropEffects.None;
        DropLocationLabel.Text = "None - no string data.";
        return;
    }

    // Set the effect based upon the KeyState.
    if ((e.KeyState & (8+32)) == (8+32) && 
        (e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) {
        // KeyState 8 + 32 = CTL + ALT

        // Link drag and drop effect.
        e.Effect = DragDropEffects.Link;

    } else if ((e.KeyState & 32) == 32 && 
        (e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) {

        // ALT KeyState for link.
        e.Effect = DragDropEffects.Link;

    } else if ((e.KeyState & 4) == 4 && 
        (e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) {

        // SHIFT KeyState for move.
        e.Effect = DragDropEffects.Move;

    } else if ((e.KeyState & 8) == 8 && 
        (e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) {

        // CTL KeyState for copy.
        e.Effect = DragDropEffects.Copy;

    } else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move)  {

        // By default, the drop action should be move, if allowed.
        e.Effect = DragDropEffects.Move;

    } else
        e.Effect = DragDropEffects.None;
        
    // Get the index of the item the mouse is below. 

    // The mouse locations are relative to the screen, so they must be 
    // converted to client coordinates.

    indexOfItemUnderMouseToDrop = 
        ListDragTarget.IndexFromPoint(ListDragTarget.PointToClient(new Point(e.X, e.Y)));

    // Updates the label text.
    if (indexOfItemUnderMouseToDrop != ListBox.NoMatches){

        DropLocationLabel.Text = "Drops before item #" + (indexOfItemUnderMouseToDrop + 1);
    } else
        DropLocationLabel.Text = "Drops at the end.";

}

[C++] 
private:
   void ListDragTarget_DragOver(Object* /*sender*/, 
      System::Windows::Forms::DragEventArgs* e)
   {

      // Determine whether string data exists in the drop data. If not, then
      // the drop effect reflects that the drop cannot occur.
      if (!e->Data->GetDataPresent(__typeof(System::String))) {

         e->Effect = DragDropEffects::None;
         DropLocationLabel->Text = S"None - no string data.";
         return;
      }

      // Set the effect based upon the KeyState.
      if ((e->KeyState & (8+32)) == (8+32) &&
         (e->AllowedEffect & DragDropEffects::Link) == DragDropEffects::Link) 
      {
         // KeyState 8 + 32 = CTL + ALT

         // Link drag and drop effect.
         e->Effect = DragDropEffects::Link;

      } else if ((e->KeyState & 32) == 32 &&
         (e->AllowedEffect & DragDropEffects::Link) == DragDropEffects::Link)
      {

         // ALT KeyState for link.
         e->Effect = DragDropEffects::Link;

      } else if ((e->KeyState & 4) == 4 &&
         (e->AllowedEffect & DragDropEffects::Move) == DragDropEffects::Move)
      {
         // SHIFT KeyState for move.
         e->Effect = DragDropEffects::Move;

      } else if ((e->KeyState & 8) == 8 &&
         (e->AllowedEffect & DragDropEffects::Copy) == DragDropEffects::Copy)
      {
         // CTL KeyState for copy.
         e->Effect = DragDropEffects::Copy;

      } else if ((e->AllowedEffect & DragDropEffects::Move) == DragDropEffects::Move)
      {
         // By default, the drop action should be move, if allowed.
         e->Effect = DragDropEffects::Move;

      } else
         e->Effect = DragDropEffects::None;

      // Get the index of the item the mouse is below.

      // The mouse locations are relative to the screen, so they must be
      // converted to client coordinates.

      indexOfItemUnderMouseToDrop =
         ListDragTarget->IndexFromPoint(
         ListDragTarget->PointToClient(Point(e->X, e->Y)));

      // Updates the label text.
      if (indexOfItemUnderMouseToDrop != ListBox::NoMatches) {

         DropLocationLabel->Text = 
            String::Concat(S"Drops before item # ",
            __box( (indexOfItemUnderMouseToDrop + 1)));
      } else
         DropLocationLabel->Text = S"Drops at the end.";

   }

[Visual Basic, C#, C++] DragEventArgs が、ドラッグアンドドロップ操作のソースとターゲットの間で渡される例を次に示します。この例では、 ListBox コントロールがデータのソース、 RichTextBox コントロールがターゲットです。この例は、 ListBox コントロールが有効なファイル名の一覧に読み込まれていることを前提にしています。ユーザーが表示されているファイル名の 1 つを ListBox コントロールから RichTextBox コントロールにドラッグすると、ファイル名が参照しているファイルを開きます。

[Visual Basic, C#, C++] ListBox コントロールの MouseDown イベントで操作が開始されます。 DragEnter イベントハンドラでは、 GetDataPresent メソッドを使用して、 RichTextBox コントロールが表示できるデータ形式かどうかを検証します。次に DragDropEffects プロパティを設定して、データがソースコントロールからターゲットコントロールにコピーされるように指定します。最後に、 RichTextBox コントロールの DragDrop イベントハンドラで、 GetData メソッドを使用して開くファイル名を取得します。

 
Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
   ' Sets the AllowDrop property so that data can be dragged onto the control.
   RichTextBox1.AllowDrop = True

   ' Add code here to populate the ListBox1 with paths to text files.

End Sub

Private Sub RichTextBox1_DragEnter(ByVal sender As Object, ByVal e As System.Windows.Forms.DragEventArgs) Handles RichTextBox1.DragEnter
   ' If the data is text, copy the data to the RichTextBox control.
   If (e.Data.GetDataPresent("Text")) Then
      e.Effect = DragDropEffects.Copy
   End If
End Sub


Private Overloads Sub RichTextBox1_DragDrop(ByVal sender As Object, ByVal e As System.Windows.Forms.DragEventArgs) Handles RichTextBox1.DragDrop
   ' Loads the file into the control. 
   RichTextBox1.LoadFile(e.Data.GetData("Text"), System.Windows.Forms.RichTextBoxStreamType.RichText)
End Sub

Private Sub ListBox1_MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles ListBox1.MouseDown
   Dim Lb As ListBox
   Dim Pt As New Point(e.X, e.Y)
   Dim Index As Integer

   ' Determines which item was selected.
   Lb = sender
   Index = Lb.IndexFromPoint(Pt)

   ' Starts a drag-and-drop operation with that item.
   If Index >= 0 Then
      Lb.DoDragDrop(Lb.Items(Index), DragDropEffects.Link)
   End If
End Sub

[C#] 
private void Form1_Load(object sender, EventArgs e) 
{
   // Sets the AllowDrop property so that data can be dragged onto the control.
   richTextBox1.AllowDrop = true;

   // Add code here to populate the ListBox1 with paths to text files.

}

private void listBox1_MouseDown(object sender, System.Windows.Forms.MouseEventArgs e)
{
   // Determines which item was selected.
   ListBox lb =( (ListBox)sender);
   Point pt = new Point(e.X,e.Y);
   int index = lb.IndexFromPoint(pt);

   // Starts a drag-and-drop operation with that item.
   if(index>=0) 
   {
      lb.DoDragDrop(lb.Items[index].ToString(), DragDropEffects.Link);
   }
}

private void richTextBox1_DragEnter(object sender, DragEventArgs e) 
{
   // If the data is text, copy the data to the RichTextBox control.
   if(e.Data.GetDataPresent("Text"))
      e.Effect = DragDropEffects.Copy;
}

private void richTextBox1_DragDrop(object sender, DragEventArgs e) 
{
   // Loads the file into the control. 
   richTextBox1.LoadFile((String)e.Data.GetData("Text"), System.Windows.Forms.RichTextBoxStreamType.RichText);
}


[C++] 
private:
    void Form1_Load(Object* /*sender*/, EventArgs* /*e*/) {
        // Sets the AllowDrop property so that data can be dragged onto the control.
        richTextBox1->AllowDrop = true;

        // Add code here to populate the ListBox1 with paths to text files.
    }

    void listBox1_MouseDown(Object* sender, System::Windows::Forms::MouseEventArgs* e) {
        // Determines which item was selected.
        ListBox* lb =(dynamic_cast<ListBox*>(sender));
        Point pt = Point(e->X, e->Y);
        int index = lb->IndexFromPoint(pt);

        // Starts a drag-and-drop operation with that item.
        if (index>=0) {
            lb->DoDragDrop(lb->Items->Item[index], DragDropEffects::Link);
        }
    }

    void richTextBox1_DragEnter(Object* /*sender*/, DragEventArgs* e) {
        // If the data is text, copy the data to the RichTextBox control.
        if (e->Data->GetDataPresent(S"Text"))
            e->Effect = DragDropEffects::Copy;
    }

    void richTextBox1_DragDrop(Object* /*sender*/, DragEventArgs* e) {
        // Loads the file into the control.
        richTextBox1->LoadFile(dynamic_cast<String*>(e->Data->GetData(S"Text")), 
            System::Windows::Forms::RichTextBoxStreamType::RichText);
    }

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Windows.Forms

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Windows.Forms (System.Windows.Forms.dll 内)

参照

次の方法で共有

DragEventArgs クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース