GridView.RowCellStyle Event

Fires for every Grid cell before this cell is shown. Allows you to modify Appearance settings for this cell.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DXCategory("Appearance")]
public event RowCellStyleEventHandler RowCellStyle
<DXCategory("Appearance")>
Public Event RowCellStyle As RowCellStyleEventHandler

Event Data

The RowCellStyle event's data class is RowCellStyleEventArgs. The following properties provide information specific to this event:

Property Description
Appearance Gets the appearance settings used to paint the data cell currently being processed.
CellValue Returns the currently processed cell value. Inherited from CustomRowCellEventArgs.
Column Gets the column to which the currently processed cell corresponds. Inherited from CustomRowCellEventArgs.
RowHandle Gets the handle of the row that contains the processed cell. Inherited from CustomRowCellEventArgs.

Remarks

Use the event's CustomRowCellEventArgs.RowHandle and CustomRowCellEventArgs.Column parameters to identify the currently processed cell, then change the RowCellStyleEventArgs.Appearance parameter to modify Appearance settings.

The Appearance of column cells sample in the DevExpress Demo Center illustrates how to apply different colors and text alignment settings to the "Name" column cells depending on whether the checkbox under the "Mark" column is checked.

    gridView.RowCellStyle += (sender, e) => {
        GridView view = sender as GridView;
        bool _mark = (bool)view.GetRowCellValue(e.RowHandle, "Mark");
        if(e.Column.FieldName == "Name") {
            e.Appearance.BackColor = _mark ? Color.LightGreen : Color.LightSalmon;
            e.Appearance.TextOptions.HAlignment = _mark ? HorzAlignment.Far : HorzAlignment.Near;
        }
        if(e.Column.FieldName == "Length") {
            double _length = (double)e.CellValue;
            if(_length > 25)
                e.Appearance.ForeColor = Color.Red;
        }
    };

To provide appearance settings for entire rows instead of individual cells, handle the GridView.RowStyle event.

TIP

Data Grid does not display cell images assigned to the Appearance.Image properties on the RowCellStyle and GridView.RowStyle events. See the "Cell Icons" section of the Cells article to learn how to provide icons for Grid cells.

IMPORTANT

Do not change cell values, modify the control's layout, or change the control's object model in the events used for custom control painting. Actions that update the layout can cause the control to malfunction.

Please refer to the Appearance and Conditional Formatting topic for additional information.

Online Video

WinForms Grid: Custom Drawing.

Examples

The following code demonstrates how to customize the appearance of individual grid cells using the GridView.RowCellStyle event handler. The grid cells in this example are colored in a staggered manner. The following image demonstrates the result:

Examples.RowCellStyle

using DevExpress.XtraGrid.Views.Grid;

private void gridView1_RowCellStyle(object sender, RowCellStyleEventArgs e) {
   GridView view = sender as GridView;
   if(view == null) return;
   if(e.RowHandle != view.FocusedRowHandle && 
      ((e.RowHandle % 2 == 0 && e.Column.VisibleIndex % 2 == 1) || 
      (e.Column.VisibleIndex % 2 == 0 && e.RowHandle % 2 == 1)))    
      e.Appearance.BackColor = Color.NavajoWhite;
}
See Also