Skip to main content

ASPxDashboard.BeforeExportDocument Event

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

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.2.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

#Declaration

public event BeforeExportDocumentWebEventHandler BeforeExportDocument

#Event Data

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

Property Description
DashboardId Gets the identifier of the current dashboard.
ExcelExportOptions Gets options related to exporting a dashboard/dashboard item to XLSX/XLS/CSV format.
ExportAction Gets the export action performed by a 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.

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 exported document using the BeforeExportDocumentWebEventArgs.HideItem method overloads. See the example below to learn how to do this.

#Example

The code snippet below shows how to hide specific dashboard items from the exported document using the ASPxDashboard.BeforeExportDocument event.

        protected void ASPxDashboard1_BeforeExportDocument(object sender, DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs e) {
            // Hides a dashboard item with the specified name from the exported document.
            e.HideItem("gridDashboardItem1");

            // Hides all filter elements from the exported document.
            e.HideItem((DashboardItem item) => item is FilterElementDashboardItem);
        }
See Also