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
'Usage
Dim instance As PaintEventArgs

public class PaintEventArgs extends EventArgs implements IDisposable
public class PaintEventArgs extends EventArgs implements IDisposable

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.

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



private Rectangle rcDraw;

private float penWidth = 5;

private void Form1_MouseDown(Object sender,
    System.Windows.Forms.MouseEventArgs e)
{
    // Determine the initial rectangle coordinates...
    rcDraw.set_X(e.get_X());
    rcDraw.set_Y(e.get_Y());
} //Form1_MouseDown

private void Form1_MouseUp(Object sender, 
    System.Windows.Forms.MouseEventArgs e)
{
    // Determine the width and height of the rectangle...
    if (e.get_X() < rcDraw.get_X()) {
        rcDraw.set_Width(rcDraw.get_X() - e.get_X());
        rcDraw.set_X(e.get_X());
    }
    else {
        rcDraw.set_Width(e.get_X() - rcDraw.get_X());
    }

    if (e.get_Y() < rcDraw.get_Y()) {
        rcDraw.set_Height(rcDraw.get_Y() - e.get_Y());
        rcDraw.set_Y(e.get_Y());
    }
    else {
        rcDraw.set_Height(e.get_Y() - rcDraw.get_Y());
    }

    // Force a repaint of the region occupied by the rectangle...
    this.Invalidate(rcDraw);
} //Form1_MouseUp

private void Form1_Paint(Object sender,
    System.Windows.Forms.PaintEventArgs e)
{
    // Draw the rectangle...
    e.get_Graphics().DrawRectangle(new Pen(Color.get_Blue(), 
        penWidth), rcDraw);
} //Form1_Paint

' 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

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

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

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show: