Export (0) Print
Expand All
Expand Minimize

Control.AllowDrop Property

Gets or sets a value indicating whether the control can accept data that the user drags onto it.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public virtual bool AllowDrop { get; set; }
/** @property */
public boolean get_AllowDrop ()

/** @property */
public void set_AllowDrop (boolean value)

public function get AllowDrop () : boolean

public function set AllowDrop (value : boolean)

Not applicable.

Property Value

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

Notes to Inheritors: When overriding the AllowDrop property in a derived class, use the base class's AllowDrop property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set accessors of the AllowDrop property; you can override only one if needed.

The following code example enables the user to drag an image or image file onto the form, and have it be displayed at the point on it is dropped. The OnPaint method is overridden to repaint the image each time the form is painted; otherwise the image would only persist until the next repainting. The DragEnter event-handling method determines the type of data being dragged into the form and provides the appropriate feedback. The DragDrop event-handling method displays the image on the form, if an Image can be created from the data. Because the DragEventArgs.X and DragEventArgs.Y values are screen coordinates, the example uses the PointToClient method to convert them to client coordinates.

private Image picture;
private Point pictureLocation;

public Form1()
{
   // Enable drag-and-drop operations and 
   // add handlers for DragEnter and DragDrop.
   this.AllowDrop = true;
   this.DragDrop += new DragEventHandler(this.Form1_DragDrop);
   this.DragEnter += new DragEventHandler(this.Form1_DragEnter);
}

protected override void OnPaint(PaintEventArgs e)
{
   // If there is an image and it has a location, 
   // paint it when the Form is repainted.
   base.OnPaint(e);
   if(this.picture != null && this.pictureLocation != Point.Empty)
   {
      e.Graphics.DrawImage(this.picture, this.pictureLocation);
   }
}

private void Form1_DragDrop(object sender, DragEventArgs e)
{
   // Handle FileDrop data.
   if(e.Data.GetDataPresent(DataFormats.FileDrop) )
   {
      // Assign the file names to a string array, in 
      // case the user has selected multiple files.
      string[] files = (string[])e.Data.GetData(DataFormats.FileDrop);
      try
      {
         // Assign the first image to the picture variable.
         this.picture = Image.FromFile(files[0]);
         // Set the picture location equal to the drop point.
         this.pictureLocation = this.PointToClient(new Point(e.X, e.Y) );
      }
      catch(Exception ex)
      {
         MessageBox.Show(ex.Message);
         return;
      }
   }

   // Handle Bitmap data.
   if(e.Data.GetDataPresent(DataFormats.Bitmap) )
   {
      try
      {
         // Create an Image and assign it to the picture variable.
         this.picture = (Image)e.Data.GetData(DataFormats.Bitmap);
         // Set the picture location equal to the drop point.
         this.pictureLocation = this.PointToClient(new Point(e.X, e.Y) );
      }
      catch(Exception ex)
      {
         MessageBox.Show(ex.Message);
         return;
      }
   }
   // Force the form to be redrawn with the image.
   this.Invalidate();
}

private void Form1_DragEnter(object sender, DragEventArgs e)
{
   // If the data is a file or a bitmap, display the copy cursor.
   if (e.Data.GetDataPresent(DataFormats.Bitmap) || 
      e.Data.GetDataPresent(DataFormats.FileDrop) ) 
   {
      e.Effect = DragDropEffects.Copy;
   }
   else
   {
      e.Effect = DragDropEffects.None;
   }
}

private Image picture;
private Point pictureLocation;

public Form1()
{
    // Enable drag-and-drop operations and 
    // add handlers for DragEnter and DragDrop.
    this.set_AllowDrop(true);
    this.add_DragDrop(new DragEventHandler(this.Form1_DragDrop));
    this.add_DragEnter(new DragEventHandler(this.Form1_DragEnter));
} //Form1

protected void OnPaint(PaintEventArgs e)
{
    // If there is an image and it has a location, 
    // paint it when the Form is repainted.
    super.OnPaint(e);
    if (this.picture != null && !this.pictureLocation.Equals(Point.Empty)) {
        e.get_Graphics().DrawImage(this.picture, this.pictureLocation);
    }
} //OnPaint

private void Form1_DragDrop(Object sender, DragEventArgs e)
{
    // Handle FileDrop data.
    if (e.get_Data().GetDataPresent(DataFormats.FileDrop)) {
        // Assign the file names to a string array, in 
        // case the user has selected multiple files.
        String files[] = (String[])(e.get_Data().GetData(
            DataFormats.FileDrop));
        try {
            // Assign the first image to the picture variable.
            this.picture = Image.FromFile(files.toString());
            // Set the picture location equal to the drop point.
            this.pictureLocation = this.PointToClient(new Point(e.get_X(), 
                e.get_Y()));
        }
        catch (System.Exception ex) {
            MessageBox.Show(ex.get_Message());
            return;
        }
    }
    // Handle Bitmap data.
    if (e.get_Data().GetDataPresent(DataFormats.Bitmap)) {
        try {
            // Create an Image and assign it to the picture variable.
            this.picture = (Image)e.get_Data().GetData(DataFormats.Bitmap);
            // Set the picture location equal to the drop point.
            this.pictureLocation = this.PointToClient(new Point(e.get_X(), 
                e.get_Y()));
        }
        catch (System.Exception ex) {
            MessageBox.Show(ex.get_Message());
            return;
        }
    }
    // Force the form to be redrawn with the image.
    this.Invalidate();
} //Form1_DragDrop

private void Form1_DragEnter(Object sender, DragEventArgs e)
{
    // If the data is a file or a bitmap, display the copy cursor.
    if (e.get_Data().GetDataPresent(DataFormats.Bitmap) || e.get_Data().
        GetDataPresent(DataFormats.FileDrop)) {
        e.set_Effect(DragDropEffects.Copy);
    }
    else {
        e.set_Effect(DragDropEffects.None);
    }
} //Form1_DragEnter

Windows 98, Windows Server 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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft