Back to Devexpress

CustomExportEventArgs.Report Property

dashboard-devexpress-dot-dashboardcommon-dot-customexporteventargs.md

latest3.5 KB
Original Source

CustomExportEventArgs.Report Property

Gets the underlying report of the exported document.

Namespace : DevExpress.DashboardCommon

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

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp
public XtraReport Report { get; }
vb
Public ReadOnly Property Report As XtraReport

Property Value

TypeDescription
XtraReport

An XtraReport object that is the underlying report of the exported document.

|

Remarks

Note

The underlying report (CustomExportEventArgs.Report) requires the DevExpress.XtraReports.v25.2.dll assembly for further customization.

Example

The following example shows how to use the DashboardViewer.CustomExport event to specify header and footer content of an exported dashboard. This event allows you to access the underlying report (XtraReport) of the exported document.

View Example

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Report property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-dashboard-add-custom-information-to-the-exported-dashboard/CS/WinViewer_CustomExport/Form1.cs#L12

csharp
private void dashboardViewer1_CustomExport(object sender, CustomExportEventArgs e) {
    var report = e.Report as XtraReport;
    var topMarginBand = report.Bands[BandKind.TopMargin];

winforms-dashboard-add-custom-information-to-the-exported-dashboard/VB/WinViewer_CustomExport/Form1.vb#L11

vb
Private Sub dashboardViewer1_CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs) Handles dashboardViewer1.CustomExport
    Dim report = TryCast(e.Report, XtraReport)
    Dim topMarginBand = report.Bands(BandKind.TopMargin)

See Also

CustomExportEventArgs Class

CustomExportEventArgs Members

DevExpress.DashboardCommon Namespace