DataGridView Events


.NET Framework Class Library
DataGridView.RowPrePaint Event

Note: This event is new in the .NET Framework version 2.0.

Occurs before a DataGridViewRow is painted

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

Syntax
Visual Basic (Declaration) 
Public Event RowPrePaint As DataGridViewRowPrePaintEventHandler
Visual Basic (Usage) 
Dim instance As DataGridView
Dim handler As DataGridViewRowPrePaintEventHandler

AddHandler instance.RowPrePaint, handler
C# 
public event DataGridViewRowPrePaintEventHandler RowPrePaint
C++ 
public:
event DataGridViewRowPrePaintEventHandler^ RowPrePaint {
    void add (DataGridViewRowPrePaintEventHandler^ value);
    void remove (DataGridViewRowPrePaintEventHandler^ value);
}
J# 
/** @event */
public void add_RowPrePaint (DataGridViewRowPrePaintEventHandler value)

/** @event */
public void remove_RowPrePaint (DataGridViewRowPrePaintEventHandler value)
JScript 
JScript supports the use of events, but not the declaration of new ones.
Remarks

You can handle this event alone or in combination with the RowPostPaint event to customize the appearance of rows in the control. You can paint entire rows yourself, or paint specific parts of rows and use the following methods of the DataGridViewRowPrePaintEventArgs class to paint other parts:

You can also use the VisualStyleRenderer class to paint standard controls using the current theme. For more information, see Rendering Controls with Visual Styles. If you are using Visual Studio 2005, you also have access to a large library of standard images that you can use with the DataGridView control.

For more information, see Visual Studio 2005 Image Library.

For more information about handling events, see Consuming Events.

Example

The following code example demonstrates how to use a handler for the RowPrePaint event to paint a gradient row background if the row is selected. This example is part of a larger example available in How to: Customize the Appearance of Rows in the Windows Forms DataGridView Control.

Visual Basic 
' Paints the custom selection background for selected rows.
Sub dataGridView1_RowPrePaint(ByVal sender As Object, _
    ByVal e As DataGridViewRowPrePaintEventArgs) _
    Handles dataGridView1.RowPrePaint

    ' Do not automatically paint the focus rectangle.
    e.PaintParts = e.PaintParts And Not DataGridViewPaintParts.Focus

    ' Determine whether the cell should be painted with the 
    ' custom selection background.
    If (e.State And DataGridViewElementStates.Selected) = _
        DataGridViewElementStates.Selected Then

        ' Calculate the bounds of the row.
        Dim rowBounds As New Rectangle( _
            Me.dataGridView1.RowHeadersWidth, e.RowBounds.Top, _
            Me.dataGridView1.Columns.GetColumnsWidth( _
            DataGridViewElementStates.Visible) - _
            Me.dataGridView1.HorizontalScrollingOffset + 1, _
            e.RowBounds.Height)

        ' Paint the custom selection background.
        Dim backbrush As New _
            System.Drawing.Drawing2D.LinearGradientBrush(rowBounds, _
            Me.dataGridView1.DefaultCellStyle.SelectionBackColor, _
            e.InheritedRowStyle.ForeColor, _
            System.Drawing.Drawing2D.LinearGradientMode.Horizontal)
        Try
            e.Graphics.FillRectangle(backbrush, rowBounds)
        Finally
            backbrush.Dispose()
        End Try
    End If

End Sub 'dataGridView1_RowPrePaint
C# 
// Paints the custom selection background for selected rows.
void dataGridView1_RowPrePaint(object sender,
        DataGridViewRowPrePaintEventArgs e)
{
    // Do not automatically paint the focus rectangle.
    e.PaintParts &= ~DataGridViewPaintParts.Focus;

    // Determine whether the cell should be painted
    // with the custom selection background.
    if ((e.State & DataGridViewElementStates.Selected) ==
                DataGridViewElementStates.Selected)
    {
        // Calculate the bounds of the row.
        Rectangle rowBounds = new Rectangle(
            this.dataGridView1.RowHeadersWidth, e.RowBounds.Top,
            this.dataGridView1.Columns.GetColumnsWidth(
                DataGridViewElementStates.Visible) -
            this.dataGridView1.HorizontalScrollingOffset + 1,
            e.RowBounds.Height);

        // Paint the custom selection background.
        using (Brush backbrush =
            new System.Drawing.Drawing2D.LinearGradientBrush(rowBounds,
                this.dataGridView1.DefaultCellStyle.SelectionBackColor,
                e.InheritedRowStyle.ForeColor,
                System.Drawing.Drawing2D.LinearGradientMode.Horizontal))
        {
            e.Graphics.FillRectangle(backbrush, rowBounds);
        }
    }
}
Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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.
Version Information

.NET Framework

Supported in: 2.0
See Also
Tags :


Community Content

DarkoLord
Coloring a row based on its contents

If you find yourself here looking for a simple way to color a row a different color based upon its contents, go back and look at the Cell Painting event. For example:

private void dgvMenus_CellPainting(object sender, DataGridViewCellPaintingEventArgs e)
{
    if (e.RowIndex > -1)
        dgvMenus.Rows[e.RowIndex].DefaultCellStyle.BackColor = 
               _presenter.GetRowColor(e.RowIndex);
}

 

Here, I ask my presenter class to give me a color to assign to this row based upon the rows index.

Tags :

dynos
What we miss in code is "e.Handled = True"

Private Sub DataGridView1_RowPrePaint(ByVal sender As System.Object, ByVal e As System.Windows.Forms.DataGridViewRowPrePaintEventArgs) Handles DataGridView1.RowPrePaint
' Do not automatically paint the focus rectangle.
e.PaintParts = e.PaintParts And Not DataGridViewPaintParts.Focus

' Determine whether the cell should be painted with the
' custom selection background.
If (e.State And DataGridViewElementStates.Selected) = DataGridViewElementStates.Selected Then

' Calculate the bounds of the row.
Dim rowBounds As New Rectangle( _
Me.DataGridView1.RowHeadersWidth, e.RowBounds.Top, _
Me.DataGridView1.Columns.GetColumnsWidth( _
DataGridViewElementStates.Visible) - _
Me.DataGridView1.HorizontalScrollingOffset + 1, _
e.RowBounds.Height)

' Paint the custom selection background.
Dim backbrush As New _
System.Drawing.Drawing2D.LinearGradientBrush(rowBounds, _
Me.DataGridView1.DefaultCellStyle.SelectionBackColor, _
e.InheritedRowStyle.ForeColor, _
System.Drawing.Drawing2D.LinearGradientMode.Horizontal)
Try
e.Graphics.FillRectangle(backbrush, rowBounds)
e.Handled = True
 Finally
backbrush.Dispose()
End Try
End If
End Sub

Please correct me if i am wrong

Tags :

Page view tracker