Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

RichTextBox.AllowDrop Property

Gets or sets a value indicating whether the control will allow drag-and-drop operations.

[Visual Basic]
Overrides Public Property AllowDrop As Boolean
[C#]
public override bool AllowDrop {get; set;}
[C++]
public: __property bool get_AllowDrop();
public: __property void set_AllowDrop(bool);
[JScript]
public override function get AllowDrop() : Boolean;
public override function set AllowDrop(Boolean);

Property Value

true if drag-and-drop is allowed in the control; otherwise, false.

Example

[Visual Basic, C#, C++] The following example demonstrates how to perform drag and drop operations using a ListBox control that contains items to drop into a RichTextBox control. The constructor of the form sets the AllowDrop property to true to enable drag and drop to occur in the RichTextBox. The example uses the MouseDown event of the ListBox to start the drag operation by calling the DoDragDrop method. The example uses the DragEnter event to determine if an item being dragged into the RichTextBox is a valid data type. The DragDrop event performs the actual dropping of a dragged item into the RichTextBox control at the current cursor location within the RichTextBox. This example assumes that the DragDrop and DragEnter events have been connected to the event handlers defined in the example.

[Visual Basic] 
Public Sub New()
   MyBase.New()

   'This call is required by the Windows Form Designer.
   InitializeComponent()

   richTextBox1.AllowDrop = True

End Sub

Private Sub listBox1_MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles listBox1.MouseDown
   ' Determines which item was selected.
   Dim lb As ListBox = CType(sender, ListBox)
   Dim pt As New Point(e.X, e.Y)
   'Retrieve the item at the specified location within the ListBox.
   Dim index As Integer = lb.IndexFromPoint(pt)

   ' Starts a drag-and-drop operation.
   If index >= 0 Then
      ' Retrieve the selected item text to drag into the RichTextBox.
      lb.DoDragDrop(lb.Items(index).ToString(), DragDropEffects.Copy)
   End If
End Sub 'listBox1_MouseDown


Private Sub richTextBox1_DragEnter(ByVal sender As Object, ByVal e As 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 'richTextBox1_DragEnter

Private Sub richTextBox1_DragDrop(ByVal sender As Object, ByVal e As DragEventArgs) Handles richTextBox1.DragDrop
   ' Paste the text into the RichTextBox where at selection location.
   richTextBox1.SelectedText = e.Data.GetData("System.String", True).ToString()
End Sub 'richTextBox1_DragDrop


[C#] 
public Form1()
{
   InitializeComponent();
   // Sets the control to allow drops, and then adds the necessary event handlers.
   this.richTextBox1.AllowDrop = true;
}
 
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);
   //Retrieve the item at the specified location within the ListBox.
   int index = lb.IndexFromPoint(pt);

   // Starts a drag-and-drop operation.
   if(index>=0) 
   {
      // Retrieve the selected item text to drag into the RichTextBox.
      lb.DoDragDrop(lb.Items[index].ToString(), DragDropEffects.Copy);
   }
}

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) 
{
   // Paste the text into the RichTextBox where at selection location.
   richTextBox1.SelectedText =  e.Data.GetData("System.String", true).ToString();
}


[C++] 
public:
   Form1()
   {
      InitializeComponent();
      // Sets the control to allow drops, and then adds the necessary event handlers.
      this->richTextBox1->AllowDrop = true;
   }

private:
   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);
      //Retrieve the item at the specified location within the ListBox.
      int index = lb->IndexFromPoint(pt);

      // Starts a drag-and-drop operation.
      if(index>=0) 
      {
         // Retrieve the selected item text to drag into the RichTextBox.
         lb->DoDragDrop(lb->Items->Item[index]->ToString(), DragDropEffects::Copy);
      }
   }

   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) 
   {
      // Paste the text into the RichTextBox where at selection location.
      richTextBox1->SelectedText =  e->Data->GetData(S"System.String", true)->ToString();
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

RichTextBox Class | RichTextBox Members | System.Windows.Forms Namespace

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft