CustomExportEventArgs.Report Property

Gets the underlying report of the exported document.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public XtraReport Report { get; }

VB.NET

Public ReadOnly Property Report As XtraReport

Property Value

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

Remarks

Note

The underlying report (CustomExportEventArgs.Report) requires the DevExpress.XtraReports.v21.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

Form1.cs

using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;

namespace WinViewer_CustomExport
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void dashboardViewer1_CustomExport(object sender, CustomExportEventArgs e)
        {

            XtraReport report = e.Report as XtraReport;
            PageHeaderBand headerBand = new PageHeaderBand();
            report.Bands.Add(headerBand);

            XRPictureBox icon = new XRPictureBox();
            icon.Image = Properties.Resources.dxLogo;
            icon.HeightF = 50;
            icon.WidthF = 300;
            headerBand.Controls.Add(icon);

            XRLabel customHeader = new XRLabel();
            customHeader.Text = "TEST TEST TEST";
            customHeader.LeftF = 300;
            customHeader.WidthF = 300;
            headerBand.Controls.Add(customHeader);

            XRPageInfo dateInfo = new XRPageInfo();
            dateInfo.PageInfo = PageInfo.DateTime;
            dateInfo.Format = "Created at {0:h:mm tt dd MMMM yyyy}";
            dateInfo.TopF = 50;
            dateInfo.WidthF = 200;
            headerBand.Controls.Add(dateInfo);

            PageFooterBand footerBand = new PageFooterBand();
            report.Bands.Add(footerBand);
            XRPageInfo pageInfo = new XRPageInfo();
            pageInfo.Format = "Page {0} of {1}";
            footerBand.Controls.Add(pageInfo);
        }
    }
}

Form1.vb

Imports DevExpress.DashboardCommon
Imports DevExpress.XtraReports.UI


Namespace WinViewer_CustomExport
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub dashboardViewer1_CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs) Handles dashboardViewer1.CustomExport

            Dim report As XtraReport = e.Report
            Dim headerBand As New PageHeaderBand()
            report.Bands.Add(headerBand)

            'INSTANT VB NOTE: The variable icon was renamed since Visual Basic does not handle local variables named the same as class members well:
            Dim icon_Renamed As New XRPictureBox()
            icon_Renamed.Image = My.Resources.dxLogo
            icon_Renamed.HeightF = 50
            icon_Renamed.WidthF = 300
            headerBand.Controls.Add(icon_Renamed)

            Dim customHeader As New XRLabel()
            customHeader.Text = "TEST TEST TEST"
            customHeader.LeftF = 300
            customHeader.WidthF = 300
            headerBand.Controls.Add(customHeader)

            Dim dateInfo As New XRPageInfo()
            dateInfo.PageInfo = DevExpress.XtraPrinting.PageInfo.DateTime
            dateInfo.Format = "Created at {0:h:mm tt dd MMMM yyyy}"
            dateInfo.TopF = 50
            dateInfo.WidthF = 200
            headerBand.Controls.Add(dateInfo)

            Dim footerBand As New PageFooterBand()
            report.Bands.Add(footerBand)
            Dim pageInfo As New XRPageInfo()
            pageInfo.Format = "Page {0} of {1}"
            footerBand.Controls.Add(pageInfo)
        End Sub
    End Class
End Namespace