PaintEventArgs Class

Provides data for the Paint event.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public class PaintEventArgs : EventArgs, 
	IDisposable

The PaintEventArgs type exposes the following members.

  NameDescription
Public methodPaintEventArgsInitializes a new instance of the PaintEventArgs class with the specified graphics and clipping rectangle.
Top

  NameDescription
Public propertyClipRectangleGets the rectangle in which to paint.
Public propertyGraphicsGets the graphics used to paint.
Top

  NameDescription
Public methodDispose()Releases all resources used by the PaintEventArgs.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the PaintEventArgs and optionally releases the managed resources.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The Paint event occurs when a control is redrawn. A PaintEventArgs specifies the Graphics to use to paint the control and the ClipRectangle in which to paint.

For information about the event model, see Events and Delegates.

The following example demonstrates handling the Paint event and using the PaintEventArgs class to draw rectangles on the form. The MouseDown and MouseUp events are handled to determine the size of the rectangle. The example also demonstrates the Invalidate method to invalidate the area of the rectangle, causing it to be redrawn.



		private Rectangle RcDraw;
		private float PenWidth = 5;

		private void Form1_MouseDown(object sender, System.Windows.Forms.MouseEventArgs e)
		{

			// Determine the initial rectangle coordinates...

			RcDraw.X = e.X;
			RcDraw.Y = e.Y;
		
		}

		private void Form1_MouseUp(object sender, System.Windows.Forms.MouseEventArgs e)
		{

			// Determine the width and height of the rectangle...

			if(e.X < RcDraw.X)
			{
				RcDraw.Width = RcDraw.X - e.X;
				RcDraw.X = e.X;
			}
			else
			{
				RcDraw.Width = e.X - RcDraw.X;
			}

			if(e.Y < RcDraw.Y)
			{
				RcDraw.Height = RcDraw.Y - e.Y;
				RcDraw.Y = e.Y;
			}
			else
			{
				RcDraw.Height = e.Y - RcDraw.Y;
			}

			// Force a repaint of the region occupied by the rectangle...

			this.Invalidate(RcDraw);
		
		}

		private void Form1_Paint(object sender, System.Windows.Forms.PaintEventArgs e)
		{

			// Draw the rectangle...

			e.Graphics.DrawRectangle(new Pen(Color.Blue, PenWidth), RcDraw);
			
		}




// 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);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft