Export (0) Print
Expand All
Expand Minimize

Control.OnPaint Method

Raises the Paint event.

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

protected virtual void OnPaint (
	PaintEventArgs e
)
protected void OnPaint (
	PaintEventArgs e
)
protected function OnPaint (
	e : PaintEventArgs
)
Not applicable.

Parameters

e

A PaintEventArgs that contains the event data.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnPaint method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnPaint in a derived class, be sure to call the base class's OnPaint method so that registered delegates receive the event.

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

// This example creates a PictureBox control on the form and draws to it.
// This example assumes that the Form_Load event handler method is
// connected to the Load event of the form.

private PictureBox pictureBox1 = new PictureBox();
private void Form1_Load(object sender, System.EventArgs e)
{
    // Dock the PictureBox to the form and set its background to white.
    pictureBox1.Dock = DockStyle.Fill;
    pictureBox1.BackColor = Color.White;
    // Connect the Paint event of the PictureBox to the event handler method.
    pictureBox1.Paint += new System.Windows.Forms.PaintEventHandler(this.pictureBox1_Paint);

    // Add the PictureBox control to the Form.
    this.Controls.Add(pictureBox1);
}

private void pictureBox1_Paint(object sender, System.Windows.Forms.PaintEventArgs e)
{
    // Create a local version of the graphics object for the PictureBox.
    Graphics g = e.Graphics;

    // Draw a string on the PictureBox.
    g.DrawString("This is a diagonal line drawn on the control",
        new Font("Arial",10), System.Drawing.Brushes.Blue, new Point(30,30));
    // Draw a line in the PictureBox.
    g.DrawLine(System.Drawing.Pens.Red, pictureBox1.Left, pictureBox1.Top,
        pictureBox1.Right, pictureBox1.Bottom);
}

// This example creates a PictureBox control on the form and draws to it.
// This example assumes that the Form_Load event handler method is
// connected to the Load event of the form.
private PictureBox pictureBox1 = new PictureBox();

private void Form1_Load(Object sender, System.EventArgs e)
{
    // Dock the PictureBox to the form and set its background to white.
    pictureBox1.set_Dock(DockStyle.Fill);
    pictureBox1.set_BackColor(Color.get_White());

    // Connect the Paint event of the PictureBox to the event handler 
    // method.
    pictureBox1.add_Paint(new System.Windows.Forms.PaintEventHandler(this.
        pictureBox1_Paint));

    // Add the PictureBox control to the Form.
    this.get_Controls().Add(pictureBox1);
} //Form1_Load

private void pictureBox1_Paint(Object sender, 
    System.Windows.Forms.PaintEventArgs e)
{
    // Create a local version of the graphics object for the PictureBox.
    Graphics g = e.get_Graphics();

    // Draw a string on the PictureBox.
    g.DrawString("This is a diagonal line drawn on the control", 
        new Font("Arial", 10), System.Drawing.Brushes.get_Blue(), 
        (PointF)new PointF(30, 30));

    // Draw a line in the PictureBox.
    g.DrawLine(System.Drawing.Pens.get_Red(), pictureBox1.get_Left(), 
        pictureBox1.get_Top(), pictureBox1.get_Right(), 
        pictureBox1.get_Bottom());
} //pictureBox1_Paint

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

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft