DashboardConfigurator.CustomizeExportDocument Event
Allows you to customize the exported document.
Namespace: DevExpress.DashboardWeb
Assembly: DevExpress.Dashboard.v19.1.Web.dll
Declaration
Event Data
The CustomizeExportDocument event's data class is CustomizeExportDocumentWebEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
DashboardId | Gets the identifier of the exported dashboard. Inherited from CustomExportBaseWebEventArgs. |
ExcelExportOptions | Gets options related to exporting a dashboard/dashboard item to the Excel format. |
ExcelOptions | Obsolete. Gets options related to exporting a dashboard item to the Excel format. |
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. |
Stream | Gets or sets a stream containing the exported document. |
Remarks
Important
To learn how to use the DashboardConfigurator‘s API, see the Server-Side API Overview topic.
CustomizeExportDocument is raised after the DashboardConfigurator.CustomExport and allows you to customize the stream containing the resulting document (such as PDF, Image or Excel). Use the CustomizeExportDocumentWebEventArgs.Stream event parameter to access the stream.
See Also