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

ASPxDashboard.CustomExport Event

Allows you to customize the exported document.

Namespace: DevExpress.DashboardWeb

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

Declaration

public event CustomExportWebEventHandler CustomExport
Public Event CustomExport As CustomExportWebEventHandler

Event Data

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

Property Description
DashboardId Gets the identifier of the exported dashboard.
ExportAction Gets the export action performed by an end-user.
ExportMode Gets the document export mode.
ImageExportOptions Gets export options related to exporting a dashboard/dashboard item to an image.
ImageOptions Obsolete. Gets export options related to exporting a dashboard/dashboard item to an image.
ItemComponentName Gets the component name of the exported dashboard item.
PdfExportOptions Gets export options related to exporting a dashboard/dashboard item to PDF format.
PdfOptions Obsolete. Gets export options related to exporting a dashboard/dashboard item to PDF format.
PrintableComponents Provides access to a dictionary containing dashboard item names and related PrintableComponents. For internal use.
Report Gets the underlying report of the exported document.

Remarks

The CustomExport event is raised is raised before saving the exported document to the PDF and Image formats, and allows you to customize the underlying report using the CustomExportWebEventArgs.Report parameter. When handling this event, you can obtain the following information.

Note

Note that a reference to the DevExpress.XtraReports.v19.1.dll assembly should be added to the project to allow customizing the underlying report (CustomExportWebEventArgs.Report).

Examples

The following example shows how to specify header and footer content of an exported dashboard using the ASPxDashboard.CustomExport event. This event provides access to the underlying report object created for the exported document.

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="WebDashboard_CustomExport.Default" %>

<%@ Register Assembly="DevExpress.Dashboard.v16.2.Web, Version=16.2.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div style="position: absolute; top: 0; left: 0; right: 0; bottom: 0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%"
            AllowExportDashboardItems="True"
            OnConfigureDataConnection="ASPxDashboard1_ConfigureDataConnection"            
            OnCustomExport="ASPxDashboard1_CustomExport">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
See Also