PivotGridControl.CustomAppearance Event

Allows the appearances of cells to be dynamically customized when the control is displayed on screen and in the print output.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

• C#
• VB.NET

public event PivotCustomAppearanceEventHandler CustomAppearance

Public Event CustomAppearance As PivotCustomAppearanceEventHandler

Event Data

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

The event data class exposes the following methods:

Remarks

Unlike custom painting applied by handling the PivotGridControl.CustomDrawCell event, appearances customized via the CustomAppearance event are used when the pivot grid is printed.

The CustomAppearance event fires for each pivot grid cell and allows you to customize the appearance of cells dynamically (depending on their contents, position, values of other cells, etc). Use the event parameter to identify the processed cell.

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.

To customize the appearance settings, use the event parameter’s PivotCustomAppearanceEventArgs.Appearance property.

To access event data while an asynchronous operation is being performed, use a thread-safe event parameter returned by the PivotCustomAppearanceEventArgs.ThreadSafeArgs property. To learn more, see Asynchronous Mode.

Example

The following example shows how to customize the appearance of specific cells via the PivotGridControl.CustomAppearance event.

In this example, custom appearance settings (the yellow background and bold font) are applied to a cell if it meets the following conditions:

• It belongs to an “ExtendedPrice” data field.
• It’s not displayed within total rows or columns.
• It’s value is larger than 1000.

The following image demonstrates code execution:

• C#
• VB.NET

using DevExpress.XtraPivotGrid;

private void pivotGridControl1_CustomAppearance(object sender, PivotCustomAppearanceEventArgs e) {
    if (e.DataField == fieldExtendedPrice && e.ColumnValueType == PivotGridValueType.Value 
        && e.RowValueType == PivotGridValueType.Value) {
        if (e.Value != null && (decimal)e.Value > 1000) {
            e.Appearance.BackColor = Color.Yellow;
            e.Appearance.FontStyleDelta = FontStyle.Bold;
        }
    }
}

Imports DevExpress.XtraPivotGrid

Private Sub pivotGridControl1_CustomAppearance(ByVal sender As System.Object, _
ByVal e As PivotCustomAppearanceEventArgs) _
Handles pivotGridControl1.CustomAppearance
    If e.DataField Is fieldExtendedPrice And e.ColumnValueType = PivotGridValueType.Value _
        And e.RowValueType = PivotGridValueType.Value Then
        If Not e.Value Is Nothing And Convert.ToDecimal(e.Value) > 1000 Then
            e.Appearance.BackColor = Color.Yellow
            e.Appearance.FontStyleDelta = FontStyle.Bold
        End If
    End If
End Sub

More Examples

View Example: Customize Appearance of the Even/Odd Groups of Cells

See Also

CustomDrawCell

PivotGridControl Class

PivotGridControl Members

DevExpress.XtraPivotGrid Namespace