IDashboardControl.CustomExport Event
Allows you to customize the exported document.
Namespace: DevExpress.DashboardWin
Assembly: DevExpress.Dashboard.v24.1.Win.dll
NuGet Package: DevExpress.Win.Dashboard
Declaration
Event Data
The CustomExport event's data class is CustomExportEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ExportAction | Gets the export action performed by an end-user. Inherited from CustomExportBaseEventArgs. |
| ExportMode | Gets the document export mode. Inherited from CustomExportBaseEventArgs. |
| ImageExportOptions | Gets export options related to exporting a dashboard/dashboard item as an image. Inherited from CustomExportBaseEventArgs. |
| ImageOptions | Obsolete. Gets export options related to exporting a dashboard/dashboard item as an image. Inherited from CustomExportBaseEventArgs. |
| ItemComponentName | Gets the component name of the exported dashboard item. Inherited from CustomExportBaseEventArgs. |
| PdfExportOptions | Gets export options related to exporting a dashboard/dashboard item to PDF format. Inherited from CustomExportBaseEventArgs. |
| PdfOptions | Obsolete. Gets export options related to exporting a dashboard/dashboard item to PDF format. Inherited from CustomExportBaseEventArgs. |
| PrintableComponents | Obsolete. Provides access to a dictionary containing dashboard item names and related PrintableComponents. For internal use. |
| PrintPreviewOptions | Gets options related to printing a dashboard/dashboard item using the Print Preview window. Inherited from CustomExportBaseEventArgs. |
| Report | Gets the underlying report of the exported document. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| GetChartContext(String) | Returns chart context for the specified Chart dashboard item. |
| GetGaugeContext(String) | Returns gauge export context for the specified Gauge dashboard item. |
| GetItemData(String) | Returns multidimensional data for the specified dashboard item. |
| GetPrintableControl(String) | Gets a printable control corresponding to the specified dashboard item. |
| GetPrintableControls() | Gets printable controls corresponding to the exported dashboard items. |
Remarks
The Dashboard Control raises the CustomExport event in the following cases:
When you invoke the Print Preview dialog or change the previewed document’s settings (margins, orientation).
Before saving the exported document to PDF and as Image formats.
The event allows you to customize the exported document.
Use the CustomExportEventArgs.GetPrintableControl / CustomExportEventArgs.GetPrintableControls methods to obtain the printable control(s) for a specific dashboard item or the entire dashboard.
Use the CustomExportEventArgs.Report property to customize the underlying report.