PivotGridControl.CustomCellValue Event

Allows you to replace cell values with values calculated in the event handler.

Namespace : DevExpress.Xpf.PivotGrid

Assembly : DevExpress.Xpf.PivotGrid.v25.2.dll

NuGet Package : DevExpress.Wpf.PivotGrid

Declaration

• C#
• VB.NET

public event PivotCellValueEventHandler CustomCellValue

Public Event CustomCellValue As PivotCellValueEventHandler

Event Data

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

The event data class exposes the following methods:

Remarks

The CustomCellValue event fires after all control calculations when cell values are filtered, grouped, and sorted. Handle the event to replace the calculated cell values with custom values. You can create custom calculations in the event handler and assign the result to the e.Value property. Use the event parameter’s SummaryValue property to obtain the summary value calculated for the cell.

Use the following event parameter’s properties to obtain the fields that correspond to the processed cell:

• e.ColumnField
• e.DataField
• e.RowField

Use the following event parameter’s properties to obtain the visual indices of the column and row that contain the cell:

• e.ColumnIndex
• e.RowIndex

You can also enable custom display text in the PivotGridControl.CustomCellDisplayText event that is raised after the CustomCellValue event.

Note

The Pivot Grid uses values from the CustomCellValue and CustomCellDisplayText events only to represent data. The control does not take these values into account when sorting, filtering, or calculating data because these operations have already completed when the events occur.

Example: Hide Column Totals

This example demonstrates how to handle the CustomCellValue event to hide the Discount field grand totals.

View Example: Pivot Grid for WPF - Hide Column Totals

• MainWindow.xaml.cs
• MainWindow.xaml.vb

private void PivotGridControl1_CustomCellValue(object sender,PivotCellValueEventArgs e) {
    if (e.ColumnValueType == FieldValueType.GrandTotal
           && e.DataField == fieldDiscount)
        e.Value = null;
}

Private Sub PivotGridControl1_CustomCellValue(ByVal sender As Object, ByVal e As PivotCellValueEventArgs)
    If e.ColumnValueType = FieldValueType.GrandTotal AndAlso e.DataField Is fieldDiscount Then
        e.Value = Nothing
    End If
End Sub

• MainWindow.xaml

<dxpg:PivotGridControl DataProcessingEngine="Optimized" 
                       Name="pivotGridControl1" 
                       CustomCellValue="PivotGridControl1_CustomCellValue">
        <dxpg:PivotGridControl.Fields>
        <!-- ... -->
        <dxpg:PivotGridField Name="fieldDiscount" Area="DataArea" CellFormat="p">
            <dxpg:PivotGridField.DataBinding>
                <dxpg:DataSourceColumnBinding ColumnName="Discount"/>
            </dxpg:PivotGridField.DataBinding>
        </dxpg:PivotGridField>
        <!-- ... -->
    </dxpg:PivotGridControl.Fields>
</dxpg:PivotGridControl>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomCellValue 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.

• XAML

wpf-pivotgrid-hide-column-totals/CS/HowToBindToMDB/MainWindow.xaml#L11

Name="pivotGridControl1"
               CustomCellValue="PivotGridControl1_CustomCellValue">
<dxpg:PivotGridControl.Fields>

See Also

CustomCellDisplayText

PivotGridControl Class

PivotGridControl Members

DevExpress.Xpf.PivotGrid Namespace