DashboardDesigner.CustomizeExportDocument Event

Allows you to customize the exported document.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v23.1.Win.dll

NuGet Packages: DevExpress.Win.Dashboard, DevExpress.Win.Dashboard.Design

Declaration

C#

public event CustomizeExportDocumentEventHandler CustomizeExportDocument

VB.NET

Public Event CustomizeExportDocument As CustomizeExportDocumentEventHandler

Event Data

The CustomizeExportDocument event's data class is CustomizeExportDocumentEventArgs. The following properties provide information specific to this event:

Property	Description
ExcelExportOptions	Gets options related to exporting a dashboard/dashboard item to Excel format.
ExcelOptions	Obsolete. Gets options related to exporting a dashboard item to Excel format.
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.
PrintPreviewOptions	Gets options related to printing a dashboard/dashboard item using the Print Preview window. Inherited from CustomExportBaseEventArgs.
Stream	Gets or sets a stream containing the exported document.

The event data class exposes the following methods:

Method	Description
GetItemData(String)	Returns multidimensional data for the specified dashboard item.

Remarks

CustomizeExportDocument is raised after the DashboardDesigner.CustomExport and allows you to customize the stream containing the resulting document (such as PDF, Image or Excel). Use the CustomizeExportDocumentEventArgs.Stream event parameter to access the stream.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomizeExportDocument event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-items/CS/TutorialsCustomItems/Form1.cs#L18

    dashboardDesigner1.CreateCustomItemBars();
    dashboardDesigner1.CustomizeExportDocument += dashboardDesigner1_CustomizeExportDocument;
}

VB.NET

winforms-dashboard-custom-items/VB/TutorialsCustomItems/Form1.vb#L15

    dashboardDesigner1.CreateCustomItemBars()
    AddHandler dashboardDesigner1.CustomizeExportDocument, AddressOf dashboardDesigner1_CustomizeExportDocument
End Sub

Implements

CustomizeExportDocument