ASPxPivotGridExporter.CustomExportCell Event
Enables you to render a different content for individual cells, if the PivotGrid is exported in the WYSIWYG mode.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v24.2.dll
NuGet Package: DevExpress.Web
#Declaration
public event EventHandler<WebCustomExportCellEventArgs> CustomExportCell
#Event Data
The CustomExportCell event's data class is WebCustomExportCellEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Appearance | Gets or sets the appearance settings used to paint the cell currently being exported. |
Apply |
Specifies whether to apply the appearance settings to a brick.
Inherited from Custom |
Brick |
Provides access to the brick that represents the contents and appearance of a cell, when it is printed or exported.
Inherited from Custom |
Column |
Gets the column field that corresponds to the current cell. |
Column |
For internal use.
Inherited from Custom |
Column |
Gets the visual index of the column that contains the current cell.
Inherited from Custom |
Column |
Gets information about a column field value that corresponds to the current cell.
Inherited from Custom |
Data |
Gets the data field that identifies the column/row where the processed cell resides. |
Format |
Gets the type of formatting.
Inherited from Custom |
Is |
Gets whether the processed cell text is entirely displayed.
Inherited from Custom |
Rect |
Defines the size and location of the printed or exported cell.
Inherited from Custom |
Row |
Gets the row field that corresponds to the current cell. |
Row |
For internal use.
Inherited from Custom |
Row |
Gets the visual index of the row that contains the current cell.
Inherited from Custom |
Row |
Gets information about a row field value that corresponds to the current cell.
Inherited from Custom |
Text |
Gets the text displayed within the processed cell.
Inherited from Custom |
Value |
Gets the processed cell value.
Inherited from Custom |
The event data class exposes the following methods:
Method | Description |
---|---|
Create |
Returns data records used to calculate a summary value for the current cell.
Inherited from Custom |
Create |
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 Custom |
Create |
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 Custom |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to limit the number of returned records.
Inherited from Custom |
#Remarks
The CustomExportCell event is raised for each cell when the ASPxPivotGrid is exported. You can handle this event to change the cell’s appearance and contents in a printed document.
Note
Data field properties cannot be changed in the Custom
Note
The Custom
#Example
This example shows how to display custom text within cells when the pivot grid’s data is exported to a file in XLS format. To do this, the ASPxPivotGridExporter.CustomExportCell
event is handled.
The image below shows the result:
using System;
using System.Drawing;
using DevExpress.XtraPivotGrid.Web;
using DevExpress.XtraPrinting;
public partial class _Default : System.Web.UI.Page
{
static double maxPrice = 99;
protected void ASPxPivotGridExporter1_CustomExportCell(
object sender,
WebCustomExportCellEventArgs e) {
if (e.DataField.FieldName == "UnitPrice" &&
Convert.ToDouble(e.Value) > 0 &&
Convert.ToDouble(e.Value) < maxPrice) {
// Specifies the cell's display text.
((TextBrick)e.Brick).Text = string.Format(
"Custom text: {0}",
((TextBrick)e.Brick).Text);
// Specifies the appearance settings used to paint the cell in a document.
e.Appearance.BackColor = Color.Green;
e.Appearance.ForeColor = Color.White;
}
}
protected void ASPxButton1_Click(object sender, EventArgs e) {
ASPxPivotGridExporter1.ExportToXls(@"C:\pivotdata.xls", TextExportMode.Text);
}
}