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

C#

public event BeforeExportDocumentEventHandler BeforeExportDocument

VB.NET

Public Event BeforeExportDocument As BeforeExportDocumentEventHandler

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.

Remarks

The BeforeExportDocument event allows you to hide specific dashboard items from the printed or exported document using the BeforeExportDocumentEventArgs.HideItem method overloads. See the example below to learn how to do this.

Example

This example demonstrates how to hide dashboard filter items when a dashboard is exported to PDF and the ExportFilters export option is set to false.

This method can be the used to handle the following events:

• DashboardDesigner.BeforeExportDocument
• DashboardViewer.BeforeExportDocument
• ASPxDashboard.BeforeExportDocument
• DashboardControl.BeforeExportDocument
• DashboardConfigurator.BeforeExportDocument

C#

using DevExpress.DashboardCommon;
// ...
        dashboardDesigner1.BeforeExportDocument += DashboardDesigner1_BeforeExportDocument;
// ...
    private void DashboardDesigner1_BeforeExportDocument(object sender, BeforeExportDocumentEventArgs e)
    {
        if (e.ExportAction == DashboardExportAction.ExportToPdf &&
            e.PdfExportOptions.ExportFilters == false)
        {
            e.HideItem(item => item is FilterElementDashboardItem ||
            item is DateFilterDashboardItem);
        }
    }

VB.NET

Imports DevExpress.DashboardCommon
' ...
        AddHandler dashboardDesigner1.BeforeExportDocument, AddressOf DashboardDesigner1_BeforeExportDocument
' ...
    Private Sub DashboardDesigner1_BeforeExportDocument(ByVal sender As Object, ByVal e As BeforeExportDocumentEventArgs)
        If e.ExportAction = DashboardExportAction.ExportToPdf AndAlso e.PdfExportOptions.ExportFilters = False Then
            e.HideItem(Function(item) TypeOf item Is FilterElementDashboardItem OrElse TypeOf item Is DateFilterDashboardItem)
        End If
    End Sub

Implements

BeforeExportDocument