Skip to main content

IDashboardControl.BeforeExportDocument Event

Allows you to hide specific dashboard items when printing or exporting the entire dashboard.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

event BeforeExportDocumentEventHandler BeforeExportDocument

Event Data

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

Property Description
ExcelExportOptions Gets options related to exporting a dashboard/dashboard item to XLSX/XLS/CSV format.
ExportAction Gets the export action performed by an end-user.
ImageExportOptions Gets export options related to exporting a dashboard/dashboard item as an image.
PdfExportOptions Gets export options related to exporting a dashboard/dashboard item to PDF format.
PrintPreviewOptions Gets options related to printing a dashboard/dashboard item using the Print Preview window.

The event data class exposes the following methods:

Method Description
HideItem(Predicate<DashboardItem>) Hides the dashboard item matching the specified predicate in the exported dashboard.
HideItem(String) Hides the dashboard item with the specified name in the exported dashboard.
See Also