DashboardConfigurator.CustomExport Event
Allows you to customize the exported document.
Namespace: DevExpress.DashboardWeb
Assembly: DevExpress.Dashboard.v19.1.Web.dll
Declaration
Event Data
The CustomExport event's data class is CustomExportWebEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| DashboardId | Gets the identifier of the exported dashboard. Inherited from CustomExportBaseWebEventArgs. |
| ExportAction | Gets the export action performed by an end-user. Inherited from CustomExportBaseWebEventArgs. |
| ExportMode | Gets the document export mode. Inherited from CustomExportBaseWebEventArgs. |
| ImageExportOptions | Gets export options related to exporting a dashboard/dashboard item to an image. Inherited from CustomExportBaseWebEventArgs. |
| ImageOptions | Obsolete. Gets export options related to exporting a dashboard/dashboard item to an image. Inherited from CustomExportBaseWebEventArgs. |
| ItemComponentName | Gets the component name of the exported dashboard item. Inherited from CustomExportBaseWebEventArgs. |
| PdfExportOptions | Gets export options related to exporting a dashboard/dashboard item to PDF format. Inherited from CustomExportBaseWebEventArgs. |
| PdfOptions | Obsolete. Gets export options related to exporting a dashboard/dashboard item to PDF format. Inherited from CustomExportBaseWebEventArgs. |
| PrintableComponents | Provides access to a dictionary containing dashboard item names and related PrintableComponents. For internal use. |
| Report | Gets the underlying report of the exported document. |
Remarks
Important
To learn how to use the DashboardConfigurator‘s API, see the Server-Side API Overview topic.
The CustomExport event is raised is raised before saving the exported document to the PDF and Image formats, and allows you to customize the underlying report using the CustomExportWebEventArgs.Report parameter. When handling this event, you can obtain the following information.
- The CustomExportBaseWebEventArgs.ExportMode allows you to determine whether an entire dashboard or an individual item is exported.
- The CustomExportBaseWebEventArgs.ExportAction property returns the export action that caused the event.
- The CustomExportBaseWebEventArgs.PdfExportOptions and CustomExportBaseWebEventArgs.ImageExportOptions properties allow you to obtain export options corresponding to the format used.
Note
Note that a reference to the DevExpress.XtraReports.v19.1.dll assembly should be added to the project to allow customizing the underlying report (CustomExportWebEventArgs.Report).