The event handler receives an argument of type CustomEditValueEventArgs containing data related to this event.
The following
CustomEditValueEventArgs properties provide information specific to this event.
| Property |
Description |
| ColumnCustomTotal |
Gets the column custom total which displays the current cell.
|
| ColumnField |
Gets the innermost column field which corresponds to the processed cell.
|
| ColumnFieldIndex |
For internal use.
|
| ColumnIndex |
Gets the visual index of the column that contains the processed cell.
|
| ColumnValueType |
Gets the type of column which contains the processed cell.
|
| Data |
For internal use.
|
| DataField |
Gets the data field which identifies the column where the processed cell resides.
|
| Item |
For internal use.
|
| RowCustomTotal |
Gets the row custom total which contains the current cell.
|
| RowField |
Gets the innermost row field which corresponds to the processed cell.
|
| RowFieldIndex |
For internal use.
|
| RowIndex |
Gets the index of the row that contains the processed cell.
|
| RowValueType |
Gets the type of row which contains the processed cell.
|
| SummaryType |
Gets the summary type of the currently processed value.
|
| SummaryValue |
Gets the summary value currently being processed.
|
| Value |
Gets or sets the edit value of the processed cell.
|
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.
NoteEdit values specified when handling the CustomEditValue event are not posted to a data source.
Use the following properties to identify which cell is currently being processed:
-
The DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnField, DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowField and DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.DataField properties return column, row and data fields that correspond to the processed cell, respectively.
-
The DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnIndex and DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowIndex properties return indexes of the column and row where the processed cell resides, respectively.
-
The DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType and 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 DevExpress.XtraPivotGrid.PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnCustomTotal and 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.
| C# |
private void pivotGridControl_CustomEditValue(object sender, CustomEditValueEventArgs e) {
if(e.DataField == fieldPercents)
e.Value = Convert.ToDouble(e.Value) * 100f;
}
|
The image below shows the result:
