PivotGridControl.CustomEditValue Event

The event handler receives an argument of type CustomEditValueEventArgs containing data related to this event.

The CustomEditValue event is raised for each data cell that has an editor assigned. This event is raised each time the cell is repainted, allowing you to change its value. To specify a custom edit value for a cell, use the event parameter's CustomEditValueEventArgs.Value property. This property initially contains a summary value calculated for this cell.

The CustomEditValue event is raised for a cell if a data field that identifies this cell has an editor assigned to the PivotGridField.FieldEdit property, or an editor is specified for this individual cell on the CustomCellEdit event. Otherwise, the CustomEditValue event is not raised for this cell. To learn more about assigning editors to data cells, see Cell Editors Overview.

Use the following properties to identify which cell is currently being processed:

• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnField (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnField), PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowField (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowField) and PivotCellEventArgsBase<TField, TData, TCustomTotal>.DataField (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.DataField) properties return column, row and data fields that correspond to the processed cell, respectively.
• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnIndex (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnIndex) and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowIndex (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowIndex) properties return indexes of the column and row where the processed cell resides, respectively.
• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType) and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowValueType (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowValueType) properties return types of the column and row where the processed cell resides, respectively.
• If the processed cell is a custom total cell, the PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnCustomTotal (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnCustomTotal) and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowCustomTotal (see DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowCustomTotal) properties return column and row custom totals that contain the processed cell, respectively. Otherwise, these properties return null (Nothing in Visual Basic).

In the following example, data cells that correspond to the Percents of the Columns field, display the percentage of the column total value. Cell values lie in the range from 0 to 1. The progress bar is used to visualize this percentage. Since a progress bar accepts values from 0 to 100, the CustomEditValue event is handled to format cell values and provide appropriate percentage.

private void pivotGridControl_CustomEditValue(object sender, CustomEditValueEventArgs e) {

    if(e.DataField == fieldPercents)

        // e.Value = 0.1502539532880652 (before) 

        e.Value = Convert.ToDouble(e.Value) * 100f;

        // e.Value = 15 (after) 

}

The image below shows the result: