PivotGridControl.ShownEditor Event
Fires after a cell editor has been invoked.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.2.dll
Declaration
Event Data
The ShownEditor event's data class is PivotCellEditEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ColumnCustomTotal | Gets the column custom total which displays the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| ColumnField | Gets the innermost column field which corresponds to the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| ColumnFieldIndex | For internal use. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| ColumnIndex | Gets the visual index of the column that contains the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| ColumnValueType | Gets the type of column which contains the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| DataField | Gets the data field which identifies the column where the processed cell resides. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| Edit | Gets the editor that has been invoked or closed. |
| RowCustomTotal | Gets the row custom total which contains the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| RowField | Gets the innermost row field that corresponds to the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| RowFieldIndex | For internal use. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| RowIndex | Gets the index of the row that contains the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| RowValueType | Gets the type of row that contains the processed cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| SummaryType | Gets the summary type of the currently processed value. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| SummaryValue | Gets the summary value currently being processed. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| Value | Gets the processed cell’s value. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| CreateDrillDownDataSource() | Returns data records used to calculate a summary value for the cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateDrillDownDataSource(List<String>) | Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateDrillDownDataSource(Int32, List<String>) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateDrillDownDataSource(Int32) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateOLAPDrillDownDataSource(List<String>) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateServerModeDrillDownDataSource(List<String>) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateServerModeDrillDownDataSource(Int32, List<String>) | 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 PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| CreateSummaryDataSource() | Returns a summary data source. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetCellValue(TField) | Returns a cell value calculated against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetCellValue(Int32, Int32) | Returns a cell value by the column and row indexes. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetCellValue(Object[], Object[], TField) | Returns a cell value calculated for the specified column and row field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetColumnFields() | Returns an array of column fields that correspond to the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetColumnGrandTotal(TField) | Returns a Column Grand Total value calculated for the current row field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetColumnGrandTotal(Object[], TField) | Returns a Column Grand Total value calculated for the specified row field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetFieldValue(TField, Int32) | Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetFieldValue(TField) | Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetGrandTotal(TField) | Gets the Grand Total value for the specified field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetNextColumnCellValue(TField) | Returns the value of the cell in the same row but in the next column. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetNextRowCellValue(TField) | Returns the value of the cell in the next row. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetPrevColumnCellValue(TField) | Returns the value of the cell in the same row but in the previous column. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetPrevRowCellValue(TField) | Returns the value of the cell in the previous row. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetRowFields() | Returns an array of the row fields that correspond to the current cell. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetRowGrandTotal(TField) | Returns a Row Grand Total value calculated for the current column field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| GetRowGrandTotal(Object[], TField) | Returns a Row Grand Total value calculated for the specified column field values, against the specified data field. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| IsFieldValueExpanded(TField) | Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| IsFieldValueRetrievable(TField) | Gets whether the value of the specified column or row field can be retrieved for the current cell by the PivotCellEventArgsBase<TField, TData, TCustomTotal>.GetFieldValue method. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
| IsOthersFieldValue(TField) | Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled. Inherited from PivotCellEventArgsBase<TField, TData, TCustomTotal>. |
Remarks
Handle the ShownEditor event to perform specific actions after a cell editor has been invoked. This can be used to perform editor initialization, in order to facilitate user input. For example, the event handler can set a specific selection within the invoked editor, or open the editor’s drop-down window. The editor can be accessed via the PivotCellEditEventArgs.Edit property.
Use the following properties to identify a particular cell whose editor has been 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).
Handle the PivotGridControl.HiddenEditor event to respond to closing an in-place editor. To prevent an in-place editor from being invoked, handle the PivotGridControl.ShowingEditor event. This event is raised before an editor is invoked, allowing you to cancel this action.
See Also