PivotGridControl.CustomExportCell Event
Enables you to render different content for individual cells in a printed or exported document, if the control is exported in the WYSIWYG mode.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v19.1.dll
Declaration
Event Data
The CustomExportCell event's data class is CustomExportCellEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Appearance | Gets the appearance settings used to paint the cell currently being exported. |
| ApplyAppearanceToBrickStyle | Specifies whether to apply the appearance settings to a brick. Inherited from CustomPrintEventArgs. |
| Brick | Provides access to the brick that represents the contents and appearance of a cell, when it is printed or exported. Inherited from CustomPrintEventArgs. |
| ColumnField | Gets the column field which corresponds to the current cell. |
| ColumnFieldIndex | For internal use. Inherited from CustomExportCellEventArgsBase. |
| ColumnIndex | Gets the visual index of the column that contains the current cell. Inherited from CustomExportCellEventArgsBase. |
| ColumnValue | Gets information about a column field value that corresponds to the current cell. Inherited from CustomExportCellEventArgsBase. |
| DataField | Gets the data field which identifies the column where the processed cell resides. |
| Focused | Gets whether the processed cell is focused. |
| FormatType | Gets the type of formatting. Inherited from CustomExportCellEventArgsBase. |
| IsTextFit | Gets whether the processed cell text is entirely displayed. Inherited from CustomExportCellEventArgsBase. |
| Rect | Defines the size and location of the printed or exported cell. Inherited from CustomPrintEventArgs. |
| RowField | Gets the row field which corresponds to the current cell. |
| RowFieldIndex | For internal use. Inherited from CustomExportCellEventArgsBase. |
| RowIndex | Gets the visual index of the row that contains the current cell. Inherited from CustomExportCellEventArgsBase. |
| RowValue | Gets information about a row field value that corresponds to the current cell. Inherited from CustomExportCellEventArgsBase. |
| Selected | Gets whether the processed cell is selected. |
| Text | Gets the text displayed within the processed cell. Inherited from CustomExportCellEventArgsBase. |
| Value | Gets the processed cell value. Inherited from CustomExportCellEventArgsBase. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| CreateDrillDownDataSource() | Returns data records used to calculate a summary value for the current cell. Inherited from CustomExportCellEventArgsBase. |
| CreateDrillDownDataSource(List<String>) | Returns data records used to calculate a summary value for the current cell. Allows you to specify data columns for the returned records. Inherited from CustomExportCellEventArgsBase. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns data records used to calculate a summary value for the current cell. Allows you to specify the data columns and limit the number of returned records. Inherited from CustomExportCellEventArgsBase. |
| CreateDrillDownDataSource(Int32) | Returns data records used to calculate a summary value for the current cell. Allows you to limit the number of returned records. Inherited from CustomExportCellEventArgsBase. |
Remarks
The CustomExportCell event is raised for each cell when the PivotGrid is being exported. You can handle this event to change the cell appearance and contents in a printed document.
Use the CustomExportCellEventArgs.Appearance parameter to specify the cell appearance and contents in a printed document such as background and foreground colors, font settings, etc.
Use the CustomExportCellEventArgsBase.ColumnIndex and CustomExportCellEventArgsBase.RowIndex parameters to obtain the position of the cells to be customized in a printed document. You can also change the cell appearance relying on the cell value or displayed text. To obtain the cell value or displayed text, use the CustomExportCellEventArgsBase.Value and CustomExportCellEventArgsBase.Text parameters, respectively.
The CustomExportCellEventArgs.Selected event parameter allows you to change the cell appearance in a printed document for selected cells.
Note
The CustomExportCell and PivotGridControl.CustomExportFieldValue events are not in effect during the export in Data-Aware mode. To customize cells in Data-Aware export mode, use the PivotXlsExportOptions.CustomizeCell and PivotXlsxExportOptions.CustomizeCell events.