PivotGridControl.ShowingEditor Event
Allows you to cancel editor activation.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.2.dll
NuGet Package: DevExpress.Win.PivotGrid
#Declaration
public event EventHandler<CancelPivotCellEditEventArgs> ShowingEditor
#Event Data
The ShowingEditor event's data class is CancelPivotCellEditEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Cancel | Gets or sets whether the event must be canceled. |
Column |
Gets the column custom total which displays the current cell.
Inherited from Pivot |
Column |
Gets the innermost column field which corresponds to the processed cell.
Inherited from Pivot |
Column |
For internal use.
Inherited from Pivot |
Column |
Gets the visual index of the column that contains the processed cell.
Inherited from Pivot |
Column |
Gets the type of column which contains the processed cell.
Inherited from Pivot |
Data |
Gets the data field which identifies the column where the processed cell resides.
Inherited from Pivot |
Repository |
Gets the repository item which identifies the settings of the in-place editor for the cell. |
Row |
Gets the row custom total which contains the current cell.
Inherited from Pivot |
Row |
Gets the innermost row field that corresponds to the processed cell.
Inherited from Pivot |
Row |
For internal use.
Inherited from Pivot |
Row |
Gets the index of the row that contains the processed cell.
Inherited from Pivot |
Row |
Gets the type of row that contains the processed cell.
Inherited from Pivot |
Summary |
Gets the summary type of the currently processed value.
Inherited from Pivot |
Summary |
Gets the summary value currently being processed.
Inherited from Pivot |
Value |
Gets the processed cell’s value.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Create |
Returns data records used to calculate a summary value for the cell.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
Inherited from Pivot |
Create |
Returns a summary data source.
Inherited from Pivot |
Get |
Returns a cell value calculated against the specified data field.
Inherited from Pivot |
Get |
Returns a cell value by the column and row indexes.
Inherited from Pivot |
Get |
Returns a cell value calculated for the specified column and row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns an array of column fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area.
Inherited from Pivot |
Get |
Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides.
Inherited from Pivot |
Get |
Gets the Grand Total value for the specified field.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the next column.
Inherited from Pivot |
Get |
Returns the value of the cell in the next row.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the previous column.
Inherited from Pivot |
Get |
Returns the value of the cell in the previous row.
Inherited from Pivot |
Get |
Returns an array of the row fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the specified column field values, against the specified data field.
Inherited from Pivot |
Is |
Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded.
Inherited from Pivot |
Is |
Gets whether the value of the specified column or row field can be retrieved for the current cell by the Pivot |
Is |
Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled.
Inherited from Pivot |
#Remarks
The ShowingEditor event is raised before a cell editor is activated, and allows you to cancel the operation. To do this, set the event parameter’s CancelPivotCellEditEventArgs.Cancel property to true.
After the editor has been invoked, the PivotGridControl.ShownEditor event fires.
Use the following event parameter’s properties to identify the cell where the editor is about to be invoked:
- The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnField, PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowField and 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 and 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 and 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 and 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).
#Example
The following code shows how to disable data editing for total cells. This is accomplished by handling the PivotGridControl.ShowingEditor
event. When handling this event, the type of the current cell can be identified via the PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowValueType parameters.
using DevExpress.XtraPivotGrid;
private void pivotGridControl1_ShowingEditor(object sender, CancelPivotCellEditEventArgs e) {
if (e.RowValueType != PivotGridValueType.Value || e.ColumnValueType != PivotGridValueType.Value)
e.Cancel = true;
}