The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardConfigurator.BeforeExportDocument Event

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

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v19.1.Web.dll


public event BeforeExportDocumentWebEventHandler BeforeExportDocument
Public Event BeforeExportDocument As BeforeExportDocumentWebEventHandler

Event Data

The BeforeExportDocument event handler receives an argument of the BeforeExportDocumentWebEventArgs type. The following properties provide information specific to this event.

Property Description
DashboardId Gets the identifier of the current dashboard.



To learn how to use the DashboardConfigurator's API, see the Server-Side API Overview topic.

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.


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

using DevExpress.DashboardWeb;
// ...
DashboardConfigurator.Default.BeforeExportDocument += Default_BeforeExportDocument;
// ...
private static void Default_BeforeExportDocument(object sender, BeforeExportDocumentWebEventArgs e) {
    // Hides a dashboard item with the specified name from the exported document.

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