GridView.RowCellStyle Event

Enables the appearance settings of individual cells to be changed.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

[DXCategory("Appearance")]
public event RowCellStyleEventHandler RowCellStyle

VB.NET

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

The event data class exposes the following methods:

Method	Description
CombineAppearance(AppearanceObject)	Copies the activated settings of the appearance object passed as the parameter.

Remarks

The RowCellStyle event is raised for individual cells before they need to be repainted. The referenced cell can be identified using the event’s CustomRowCellEventArgs.RowHandle and CustomRowCellEventArgs.Column parameters. To customize the cell’s appearance settings, use the RowCellStyleEventArgs.Appearance property.

To provide appearance settings for entire rows (not just for individual cells) the GridView.RowStyle event can be handled instead.

Setting an image to the Appearance.Image property has no effect when custom painting via the RowCellStyle and GridView.RowStyle events.

Note

The control’s events designed to change the appearance or rendering of control elements must not be used to update cell values or to modify the control’s layout. Any inappropriate operation which causes a layout update, may break the normal control behavior.

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

Online Video

WinForms Grid: Custom Drawing.

Example

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:

C#

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

VB.NET

Imports DevExpress.XtraGrid.Views.Grid

Private Sub gridView1_RowCellStyle(ByVal sender As Object, _
  ByVal e As RowCellStyleEventArgs) Handles gridView1.RowCellStyle
    Dim view As GridView = sender
    If view Is Nothing Then
        Return
    End If
    If e.RowHandle <> view.FocusedRowHandle And _
        ((e.RowHandle Mod 2 = 0 And e.Column.VisibleIndex Mod 2 = 1) Or _
        (e.Column.VisibleIndex Mod 2 = 0 And e.RowHandle Mod 2 = 1)) Then _
            e.Appearance.BackColor = Color.NavajoWhite
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RowCellStyle event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-implement-hot-tracking-for-grid-rows-e724/CS/E724/CS/ViewHotTrackHelper.cs#L34

    targetView.ShownEditor += TargetView_ShownEditor;
    targetView.RowCellStyle += TargetView_RowCellStyle;
}

how-to-disable-a-particular-row-in-the-gridview-e2055/CS/WindowsApplication1/RowStateHelper.cs#L39

{
    view.RowCellStyle += view_RowCellStyle;
    view.ShowingEditor += view_ShowingEditor;

how-to-highlight-modified-cells-in-grid-t190692/CS/Form1.cs#L15

gridControl1.DataSource = GetData(10);
gridView1.RowCellStyle += gridView1_RowCellStyle;
gridView1.CellValueChanged += gridView1_CellValueChanged;

how-to-implement-a-flashing-cell-in-gridview-e2987/CS/FlashedCell.cs#L28

_View = view;
view.RowCellStyle += view_RowCellStyle;
timer.Tick += timer_Tick;

how-to-set-a-cell-color-e4612/CS/CellColorHelper.cs#L24

    _View = view;
    _View.RowCellStyle += _View_RowCellStyle;
}

VB.NET

how-to-implement-hot-tracking-for-grid-rows-e724/VB/E724/CS/ViewHotTrackHelper.vb#L43

    AddHandler targetView.ShownEditor, AddressOf TargetView_ShownEditor
    AddHandler targetView.RowCellStyle, AddressOf TargetView_RowCellStyle
End Sub

how-to-disable-a-particular-row-in-the-gridview-e2055/VB/WindowsApplication1/RowStateHelper.vb#L35

If view IsNot Nothing Then
    AddHandler view.RowCellStyle, AddressOf view_RowCellStyle
    AddHandler view.ShowingEditor, AddressOf view_ShowingEditor

how-to-highlight-modified-cells-in-grid-t190692/VB/Form1.vb#L17

gridControl1.DataSource = GetData(10)
AddHandler gridView1.RowCellStyle, AddressOf gridView1_RowCellStyle
AddHandler gridView1.CellValueChanged, AddressOf gridView1_CellValueChanged

grid-control-create-an-example-to-demonstrate-how-to-introduce-spacing-between-columns-e4254/VB/ColumnSpacing/Form1.vb#L33

Private Sub myGridView1_RowCellStyle(ByVal sender As Object, ByVal e As RowCellStyleEventArgs) Handles myGridView1.RowCellStyle
    If cbRowCellStyle.Checked Then

how-to-implement-a-flashing-cell-in-gridview-e2987/VB/FlashedCell.vb#L27

_View = view
AddHandler view.RowCellStyle, AddressOf view_RowCellStyle
AddHandler timer.Tick, AddressOf timer_Tick