This topic has not yet been rated - Rate this topic

DataGridViewRowPrePaintEventArgs Class

Provides data for the RowPrePaint event.

System.Object
  System.EventArgs
    System.ComponentModel.HandledEventArgs
      System.Windows.Forms.DataGridViewRowPrePaintEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public class DataGridViewRowPrePaintEventArgs : HandledEventArgs

The DataGridViewRowPrePaintEventArgs type exposes the following members.

  Name Description
Public method DataGridViewRowPrePaintEventArgs Initializes a new instance of the DataGridViewRowPrePaintEventArgs class.
Top
  Name Description
Public property ClipBounds Gets or sets the area of the DataGridView that needs to be repainted.
Public property ErrorText Gets a string that represents an error message for the current DataGridViewRow.
Public property Graphics Gets the Graphics used to paint the current DataGridViewRow.
Public property 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.)
Public property InheritedRowStyle Gets the cell style applied to the row.
Public property IsFirstDisplayedRow Gets a value indicating whether the current row is the first row currently displayed in the DataGridView.
Public property IsLastVisibleRow Gets a value indicating whether the current row is the last visible row in the DataGridView.
Public property PaintParts The cell parts that are to be painted.
Public property RowBounds Get the bounds of the current DataGridViewRow.
Public property RowIndex Gets the index of the current DataGridViewRow.
Public property State Gets the state of the current DataGridViewRow.
Top
  Name Description
Public method DrawFocus Draws the focus rectangle around the specified bounds.
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. (Inherited from Object.)
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 PaintCells Paints the specified cell parts for the area in the specified bounds.
Public method PaintCellsBackground Paints the cell backgrounds for the area in the specified bounds.
Public method PaintCellsContent Paints the cell contents for the area in the specified bounds.
Public method PaintHeader(Boolean) Paints the entire row header of the current DataGridViewRow.
Public method PaintHeader(DataGridViewPaintParts) Paints the specified parts of the row header of the current row.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ