PaintEventArgs Class

Provides data for the Paint event.

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

'Declaration
Public Class PaintEventArgs _
	Inherits EventArgs _
	Implements 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 methodDisposeReleases 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 the default hash function. (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 Handling and Raising Events.

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.

    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
' 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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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
Show:
© 2015 Microsoft