DashboardDesigner.CustomExport Event

Allows you to customize the exported document.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v18.2.Win.dll

Declaration

C#

public event CustomExportEventHandler CustomExport

VB.NET

Public Event CustomExport As CustomExportEventHandler

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 to an image. Inherited from CustomExportBaseEventArgs.
ImageOptions	Obsolete. Gets export options related to exporting a dashboard/dashboard item to 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	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.

Remarks

The CustomExport event is raised before saving the exported document to the PDF and Image formats, and allows you to customize the underlying report using the CustomExportEventArgs.Report parameter. When handling this event, you can obtain the following information.

• The CustomExportBaseEventArgs.ExportMode allows you to determine whether an entire dashboard or an individual item is exported.
• The CustomExportBaseEventArgs.ExportAction property returns the export action that caused the event.
• The CustomExportBaseEventArgs.PdfExportOptions and CustomExportBaseEventArgs.ImageExportOptions properties allow you to obtain export options corresponding to the used format.

Note

Note that a reference to the DevExpress.XtraReports.v18.2.dll assembly should be added to the project to allow customizing the underlying report (CustomExportEventArgs.Report).