VGridControlBase.RecordCellStyle Event

Enables the appearance settings of individual cells to be changed.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v18.1.dll

Declaration

C#

public event GetCustomRowCellStyleEventHandler RecordCellStyle

VB.NET

Public Event RecordCellStyle As GetCustomRowCellStyleEventHandler

Event Data

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

Property	Description
Appearance	Gets the appearance settings used to paint the cell currently being processed.
CellIndex	Gets the processed cell’s index. Inherited from RowCellEventArgs.
RecordIndex	Gets the index of the record containing the processed cell. Inherited from RowCellEventArgs.
Row	Gets the processed row. Inherited from RowEventArgs.

Remarks

The RecordCellStyle event is raised for individual cells before they need to be repainted. The referenced cell can be identified using the event parameter’s RowEventArgs.Row, RowCellEventArgs.RecordIndex and RowCellEventArgs.CellIndex properties. To customize the cell’s appearance settings use the GetCustomRowCellStyleEventArgs.Appearance property.

Individual cells can also be custom painted. Handle the VGridControlBase.CustomDrawRowValueCell event for this purpose.

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.

Example

The following example handles the VGridControlBase.RecordCellStyle event to modify the appearance of the “Price” row’s cells whose values are greater than 30,000.

C#

using DevExpress.XtraVerticalGrid.Events;

private void vGridControl1_RecordCellStyle(object sender, GetCustomRowCellStyleEventArgs e) {
   if(e.Row != rowPrice) return;
   if(Convert.ToInt32(vGridControl1.GetCellValue(e.Row, e.RecordIndex)) > 30000) {
      e.Appearance.BackColor = Color.Yellow;
      e.Appearance.ForeColor = Color.Black;
      e.Appearance.Font = new Font(e.Appearance.Font.Name, 
        e.Appearance.Font.Size, FontStyle.Bold);
   }
}

VB.NET

Imports DevExpress.XtraVerticalGrid.Events

Private Sub VGridControl1_RecordCellStyle(ByVal sender As Object, _
ByVal e As GetCustomRowCellStyleEventArgs) Handles VGridControl1.RecordCellStyle
    If e.Row <> rowPrice Then Exit Sub
    If Convert.ToInt32(VGridControl1.GetCellValue(e.Row, e.RecordIndex)) > 30000 Then
        e.Appearance.BackColor = Color.Yellow
        e.Appearance.ForeColor = Color.Black
        e.Appearance.Font = New Font(e.Appearance.Font.Name, _
           e.Appearance.Font.Size, FontStyle.Bold)
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RecordCellStyle 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-set-different-styles-for-even-and-odd-rows-in-the-xtraverticalgrid-e674/CS/Form1.cs#L133

this.vGridControl1.TabIndex = 0;
this.vGridControl1.RecordCellStyle += new DevExpress.XtraVerticalGrid.Events.GetCustomRowCellStyleEventHandler(this.vGridControl1_RecordCellStyle);
//

VB.NET

how-to-set-different-styles-for-even-and-odd-rows-in-the-xtraverticalgrid-e674/VB/Form1.vb#L193

Private Sub vGridControl1_RecordCellStyle(ByVal sender As Object, ByVal e As DevExpress.XtraVerticalGrid.Events.GetCustomRowCellStyleEventArgs) Handles vGridControl1.RecordCellStyle
    Dim index As Integer