PivotGridControl.CustomEditValue Event

Enables you to change cell values.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

• C#
• VB.NET

public event CustomEditValueEventHandler CustomEditValue

Public Event CustomEditValue As CustomEditValueEventHandler

Event Data

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

The event data class exposes the following methods:

Remarks

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

To assign an editor to a cell, use the PivotGridField.FieldEdit property, or handle the PivotGridControl.CustomCellEdit event.

Note

Cell values assigned in the CustomEditValue event handler are not posted to a data source. You can handle the PivotGridControl.EditValueChanged event to accomplish this.

Use the following properties to identify the edited cell:

• The e.ColumnField, e.RowField and e.DataField properties return column, row and data fields related to the current cell.
• The e.ColumnIndex and e.RowIndex properties return the zero-based index of the cell’s column or row. Note that the index is calculated based on visible rows or columns, thus collapsed and expanded rows/columns have different indexes.
• The e.ColumnValueType and e.RowValueType properties return column adn row types.
• If the current cell is a custom total cell, the e.ColumnCustomTotal and e.RowCustomTotal properties return column and row custom totals. Otherwise, these properties return null ( Nothing in Visual Basic).

In the following example, the Percents of the Columns field’s cells display the percentage of the column total value. Cell values are in the range from 0 to 1. The progress bar visualizes the percentage value. The CustomEditValue event handler translates the 0 to 1 range values to the 0 to 100 range that is acceptable for the progress bar.

• C#

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:

See Also

Cell Editors Overview

In-Place Editors - Demo Center

How to Edit and Save Cell Values

PivotGridControl Class

PivotGridControl Members

DevExpress.XtraPivotGrid Namespace