Skip to main content
All docs
V25.1
  • DashboardExporter.CustomizeExportDocument Event

    Allows you to customize the exported document.

    Namespace: DevExpress.DashboardCommon

    Assembly: DevExpress.Dashboard.v25.1.Core.dll

    NuGet Package: DevExpress.Dashboard.Core

    Declaration

    public event CustomizeExportDocumentEventHandler CustomizeExportDocument

    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.
    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.
    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.
    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 DashboardExporter.CustomExport event and allows you to customize the stream that contains the resulting document (PDF, image or Excel).

    See Also