Back to Devexpress

DashboardControl.BeforeExportDocument Event

dashboard-devexpress-dot-dashboardwpf-dot-dashboardcontrol-6c83edc7.md

latest3.1 KB
Original Source

DashboardControl.BeforeExportDocument Event

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

Namespace : DevExpress.DashboardWpf

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

NuGet Package : DevExpress.Wpf.Dashboard

Declaration

csharp
public event BeforeExportDocumentEventHandler BeforeExportDocument
vb
Public Event BeforeExportDocument As BeforeExportDocumentEventHandler

Event Data

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

PropertyDescription
ExcelExportOptionsGets options related to exporting a dashboard/dashboard item to XLSX/XLS/CSV format.
ExportActionGets the export action performed by an end-user.
ImageExportOptionsGets export options related to exporting a dashboard/dashboard item as an image.
PdfExportOptionsGets export options related to exporting a dashboard/dashboard item to PDF format.
PrintPreviewOptionsGets options related to printing a dashboard/dashboard item using the Print Preview window.

The event data class exposes the following methods:

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

Remarks

The BeforeExportDocument event allows you to hide specific dashboard items from the printed or exported document using the BeforeExportDocumentEventArgs.HideItem method overloads.

See Also

DashboardControl Class

DashboardControl Members

DevExpress.DashboardWpf Namespace