The event handler receives an argument of type PivotCellEditEventArgs containing data related to this event.
The following
PivotCellEditEventArgs 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. |
| Edit |
Gets the editor that has been invoked or closed. |
| 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 the processed cell's value. |
End-users can hide in-place editors by pressing the ENTER or ESC key or moving focus outside the edited cell. You can also perform the same via code by calling either the CloseEditor or the HideEditor method. In any of these instances, the HiddenEditor event is raised.
Note that the HiddenEditor event is raised after the edited value has been validated, and the editor has been destroyed. You can handle this event to perform any cleanup necessary after executing the ShownEditor event handler, or to perform other actions when the editor is closed.
Use the PivotCellEditEventArgs.Edit property to obtain the processed editor.
Use the following properties to identify a particular cell whose editor has been closed.
- 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).