Back to Devexpress

DashboardDesigner.CustomizeExportDocument Event

dashboard-devexpress-dot-dashboardwin-dot-dashboarddesigner-778cedfa.md

latest5.6 KB
Original Source

DashboardDesigner.CustomizeExportDocument Event

Allows you to customize the exported document.

Namespace : DevExpress.DashboardWin

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

NuGet Package : DevExpress.Win.Dashboard

Declaration

csharp
public event CustomizeExportDocumentEventHandler CustomizeExportDocument
vb
Public Event CustomizeExportDocument As CustomizeExportDocumentEventHandler

Event Data

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

PropertyDescription
ExcelExportOptionsGets options related to exporting a dashboard/dashboard item to Excel format.
ExportActionGets the export action performed by an end-user. Inherited from CustomExportBaseEventArgs.
ExportModeGets the document export mode. Inherited from CustomExportBaseEventArgs.
ImageExportOptionsGets export options related to exporting a dashboard/dashboard item as an image. Inherited from CustomExportBaseEventArgs.
ItemComponentNameGets the component name of the exported dashboard item. Inherited from CustomExportBaseEventArgs.
PdfExportOptionsGets export options related to exporting a dashboard/dashboard item to PDF format. Inherited from CustomExportBaseEventArgs.
PrintPreviewOptionsGets options related to printing a dashboard/dashboard item using the Print Preview window. Inherited from CustomExportBaseEventArgs.
StreamGets or sets a stream containing the exported document.

The event data class exposes the following methods:

MethodDescription
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.

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.

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

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

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

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

Implements

CustomizeExportDocument

See Also

CustomExport

DashboardDesigner Class

DashboardDesigner Members

DevExpress.DashboardWin Namespace