PaintEventArgs Class (System.Windows.Forms)

Switch View :
ScriptFree
.NET Framework Class Library
PaintEventArgs Class

Provides data for the Paint event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.Windows.Forms.PaintEventArgs
      System.Windows.Forms.TableLayoutCellPaintEventArgs

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

Visual Basic
Public Class PaintEventArgs _
	Inherits EventArgs _
	Implements IDisposable
C#
public class PaintEventArgs : EventArgs, 
	IDisposable
Visual C++
public ref class PaintEventArgs : public EventArgs, 
	IDisposable
F#
type PaintEventArgs =  
    class
        inherit EventArgs
        interface IDisposable
    end

The PaintEventArgs type exposes the following members.

Constructors

  Name Description
Public method PaintEventArgs Initializes a new instance of the PaintEventArgs class with the specified graphics and clipping rectangle.
Top
Properties

  Name Description
Public property ClipRectangle Gets the rectangle in which to paint.
Public property Graphics Gets the graphics used to paint.
Top
Methods

  Name Description
Public method Dispose() Releases all resources used by the PaintEventArgs.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the PaintEventArgs and optionally releases the managed resources.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

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.

Examples

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.

Visual Basic

    Dim RcDraw As Rectangle
    Dim PenWidth As Integer = 5


    Private Sub Form1_MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles MyBase.MouseDown

        ' Determine the initial rectangle coordinates...

        RcDraw.X = e.X
        RcDraw.Y = e.Y

    End Sub

    Private Sub Form1_MouseUp(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles MyBase.MouseUp

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

        If e.X < RcDraw.X Then
            RcDraw.Width = RcDraw.X - e.X
            RcDraw.X = e.X
        Else
            RcDraw.Width = e.X - RcDraw.X
        End If

        If e.Y < RcDraw.Y Then
            RcDraw.Height = RcDraw.Y - e.Y
            RcDraw.Y = e.Y
        Else
            RcDraw.Height = e.Y - RcDraw.Y
        End If

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

        Me.Invalidate(RcDraw)

    End Sub

    Private Sub Form1_Paint(ByVal sender As Object, ByVal e As System.Windows.Forms.PaintEventArgs) Handles MyBase.Paint

        ' Draw the rectangle...

        e.Graphics.DrawRectangle(New Pen(Color.Blue, PenWidth), RcDraw)

    End Sub




C#


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



Visual C++

private:
   Rectangle RcDraw;
   void Form1_MouseDown( Object^ /*sender*/, System::Windows::Forms::MouseEventArgs^ e )
   {
      // Determine the initial rectangle coordinates...
      RcDraw.X = e->X;
      RcDraw.Y = e->Y;
   }

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

   void Form1_Paint( Object^ /*sender*/, System::Windows::Forms::PaintEventArgs^ e )
   {
      // Draw the rectangle...
      float PenWidth = 5;
      e->Graphics->DrawRectangle( gcnew Pen( Color::Blue,PenWidth ), RcDraw );
   }


Visual Basic

' 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 pictureBox1 As New PictureBox()

Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
    ' 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.
    AddHandler pictureBox1.Paint, AddressOf Me.pictureBox1_Paint

    ' Add the PictureBox control to the Form.
    Me.Controls.Add(pictureBox1)
End Sub 'Form1_Load


Private Sub pictureBox1_Paint(ByVal sender As Object, ByVal e As System.Windows.Forms.PaintEventArgs)
    ' Create a local version of the graphics object for the PictureBox.
    Dim g As Graphics = e.Graphics

    ' Draw a string on the PictureBox.
    g.DrawString("This is a diagonal line drawn on the control", _
        New Font("Arial", 10), Brushes.Red, New PointF(30.0F, 30.0F))
    ' Draw a line in the PictureBox.
    g.DrawLine(System.Drawing.Pens.Red, pictureBox1.Left, _ 
        pictureBox1.Top, pictureBox1.Right, pictureBox1.Bottom)
End Sub 'pictureBox1_Paint


C#

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


Visual C++

   // 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;
   void Form1_Load( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      pictureBox1 = gcnew PictureBox;

      // 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 += gcnew System::Windows::Forms::PaintEventHandler( this, &Form1::pictureBox1_Paint );

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

   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",
         gcnew System::Drawing::Font( "Arial",10 ), System::Drawing::Brushes::Blue, Point(30,30) );

      // Draw a line in the PictureBox.
      g->DrawLine( System::Drawing::Pens::Red, pictureBox1->Left, pictureBox1->Top,
         pictureBox1->Right, pictureBox1->Bottom );
   }


Version Information

.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
Platforms

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.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference