How to: Add Custom Information to the Exported Dashboard at Runtime using the CustomExport Event

• Mar 31, 2018
• 2 minutes to read

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-dashboard-how-to-add-custom-information-to-the-exported-dashboard-t466558.

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 = "Additioanl Header Text";
            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 = 100;
            dateInfo.WidthF = 200;
            headerBand.Controls.Add(dateInfo);

            XRPageInfo userInfo = new XRPageInfo();
            userInfo.PageInfo = PageInfo.UserName;
            userInfo.Format = "Current User: {0}";
            userInfo.TopF = 100;
            userInfo.LeftF = 250;
            userInfo.WidthF = 200;
            headerBand.Controls.Add(userInfo);

            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 System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.XtraPrinting
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 = TryCast(e.Report, XtraReport)
            Dim headerBand As New PageHeaderBand()
            report.Bands.Add(headerBand)

            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 = "Additioanl Header Text"
            customHeader.LeftF = 300
            customHeader.WidthF = 300
            headerBand.Controls.Add(customHeader)

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

            Dim userInfo As New XRPageInfo()
            userInfo.PageInfo = pageInfo.UserName
            userInfo.Format = "Current User: {0}"
            userInfo.TopF = 100
            userInfo.LeftF = 250
            userInfo.WidthF = 200
            headerBand.Controls.Add(userInfo)

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