DataGridViewRowPrePaintEventArgs Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

DataGridViewRowPrePaintEventArgs.cs

Provides data for the RowPrePaint event.

public ref class DataGridViewRowPrePaintEventArgs : System::ComponentModel::HandledEventArgs

public class DataGridViewRowPrePaintEventArgs : System.ComponentModel.HandledEventArgs

type DataGridViewRowPrePaintEventArgs = class
    inherit HandledEventArgs

Public Class DataGridViewRowPrePaintEventArgs
Inherits HandledEventArgs

Inheritance

Object

EventArgs

HandledEventArgs

DataGridViewRowPrePaintEventArgs

Examples

The following code example demonstrates how to handle the RowPrePaint event to draw a custom background for selected cells. This code example is part of a larger example provided in How to: Customize the Appearance of Rows in the Windows Forms DataGridView Control.

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

' 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

Remarks

The RowPrePaint event occurs before a row is painted on a DataGridView control. RowPrePaint enables you to manually adjust the appearance of the row before any of the cells in the row are painted. This is useful if you want to customize the row, such as to produce a row where the content of one column spans multiple columns. Use the properties in DataGridViewRowPrePaintEventArgs to get the settings of the row without directly accessing the row in the DataGridView.

Constructors

DataGridViewRowPrePaintEventArgs(DataGridView, Graphics, Rectangle, Rectangle, Int32, DataGridViewElementStates, String, DataGridViewCellStyle, Boolean, Boolean)

Initializes a new instance of the DataGridViewRowPrePaintEventArgs class.

Properties

ClipBounds	Gets or sets the area of the DataGridView that needs to be repainted.
ErrorText	Gets a string that represents an error message for the current DataGridViewRow.
Graphics	Gets the Graphics used to paint the current DataGridViewRow.
Handled	Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing. (Inherited from HandledEventArgs)
InheritedRowStyle	Gets the cell style applied to the row.
IsFirstDisplayedRow	Gets a value indicating whether the current row is the first row currently displayed in the DataGridView.
IsLastVisibleRow	Gets a value indicating whether the current row is the last visible row in the DataGridView.
PaintParts	The cell parts that are to be painted.
RowBounds	Get the bounds of the current DataGridViewRow.
RowIndex	Gets the index of the current DataGridViewRow.
State	Gets the state of the current DataGridViewRow.

Methods

DrawFocus(Rectangle, Boolean)	Draws the focus rectangle around the specified bounds.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PaintCells(Rectangle, DataGridViewPaintParts)	Paints the specified cell parts for the area in the specified bounds.
PaintCellsBackground(Rectangle, Boolean)	Paints the cell backgrounds for the area in the specified bounds.
PaintCellsContent(Rectangle)	Paints the cell contents for the area in the specified bounds.
PaintHeader(Boolean)	Paints the entire row header of the current DataGridViewRow.
PaintHeader(DataGridViewPaintParts)	Paints the specified parts of the row header of the current row.
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• DataGridView
• RowPrePaint