Back to Devexpress

Manage Exporting Capabilities in ASP.NET Web Forms

dashboard-12140-web-dashboard-integrate-dashboard-component-aspnet-web-forms-dashboard-control-manage-exporting-capabilities.md

latest36.8 KB
Original Source

Manage Exporting Capabilities in ASP.NET Web Forms

  • Dec 19, 2023
  • 13 minutes to read

The ASP.NET Web Forms Dashboard control allows users to export an entire dashboard or individual dashboard items.

Server-Side API

ASPxDashboard

The ASPxDashboard control’s server-side API allows you to customize the default export options, customize export documents at runtime, etc.

ASPxDashboard.AllowExportDashboardGets or sets whether the entire dashboard can be exported by end-users.ASPxDashboard.AllowExportDashboardItemsGets or sets whether the dashboard items can be exported by end-users.ASPxDashboard.PdfExportOptionsProvides access to options related to exporting a dashboard/dashboard item to PDF format.ASPxDashboard.ImageExportOptionsProvides access to options related to exporting a dashboard/dashboard item to an image.ASPxDashboard.ExcelExportOptionsProvides access to options related to exporting a dashboard item to Excel format.ASPxDashboard.BeforeExportDocumentAllows you to hide specific dashboard items when exporting the entire dashboard.ASPxDashboard.CustomExportAllows you to customize the exported document.ASPxDashboard.CustomizeExportDocumentAllows you to customize the stream containing the resulting document (such as PDF, Image, or Excel).

ASPxDashboardExporter

The ASPxDashboardExporter class allows you to implement server export for the Web Forms Dashboard Control. It uses information stored in a dashboard state to determine the currently selected filters, drill-down levels and parameter values. The state overrides default values specified in dashboard items and parameters. An empty state for the ASPxDashboardExporter means that an end-user has cleared all filters and parameters, and canceled all drill-down operations. The ASPxDashboardExporter inherits members of the WebDashboardExporter class.

WebDashboardExporter.ExportDashboardItemToExcelExports the dashboard item to the specified stream in Excel format.WebDashboardExporter.ExportDashboardItemToImageExports the dashboard item to the specified stream in Image format.WebDashboardExporter.ExportDashboardItemToPdfExports the dashboard item to the specified stream in PDF format.WebDashboardExporter.ExportToExcelExports a dashboard to the specified stream in Excel format.WebDashboardExporter.ExportToImageExports a dashboard to the specified stream in Image format.WebDashboardExporter.ExportToPdfExports a dashboard to the specified stream in PDF format.

To initialize ASPxDashboardExporter for the specified ASPxDashboard control, pass the control’s instance to the ASPxDashboardExporter constructor.

csharp
using DevExpress.DashboardWeb;
//...            
ASPxDashboardExporter exporter = new ASPxDashboardExporter(ASPxDashboard1);
vb
Imports DevExpress.DashboardWeb
'...            
Private exporter As New ASPxDashboardExporter(ASPxDashboard1)

[!exampleImplement server-side exportView Example: Add custom information to the exported dashboardView Example: Export a dashboard to PDF with different filter values on different pages

DashboardExporter

You can use the non-visual DashboardExporter component to implement server-side export of a dashboard or dashboard items without referencing dashboard UI controls ( DashboardDesigner, DashboardViewer, ASPxDashboard, and so on) or DashboardConfigurator.

To integrate the DashboardExporter into a service, register the DevExpress NuGet feed as a package source and install the DevExpress.Dashboard.Core package. See the DashboardExporter class description for details.

Example: Export Dashboards in a Console Application

The following example shows how to use the DashboardExporter component in a console application to export Dashboards in PDF format.

View Example

cs
using System;
using System.IO;
using DevExpress.DashboardCommon;

namespace DashboardExporterApp {
    class Program {
        static void Main(string[] args) {
            if(args.Length < 1 || !Directory.Exists(args[0])) {
                Console.WriteLine("Path to the dashboard and output folders are required");
                return;
            }
            string[] dashboards = Directory.GetFiles(args[0], "*.xml");
            string outputFolder = args[1];
            DashboardExporter exporter = new DashboardExporter();
            exporter.ConnectionError += Exporter_ConnectionError;
            exporter.DataLoadingError += Exporter_DataLoadingError;
            exporter.DashboardItemDataLoadingError += Exporter_DashboardItemDataLoadingError;
            foreach(string dashboard in dashboards) {
                string outputFile = Path.Combine(outputFolder, 
                    $"{Path.GetFileNameWithoutExtension(dashboard)}.pdf");
                using FileStream stream = new FileStream(outputFile, FileMode.OpenOrCreate);
                try {
                    exporter.ExportToPdf(dashboard, stream);
                }
                catch(Exception e) {
                    Console.WriteLine($"Unable to export {dashboard}.");
                    Console.WriteLine(e.Message);
                    continue;
                }
            }
            Console.WriteLine("Done!");
        }
        static void Exporter_ConnectionError(object sender,
            DashboardExporterConnectionErrorEventArgs e) {
            Console.WriteLine(
                $"The following error occurs in {e.DataSourceName}: {e.Exception.Message}");
        }
        static void Exporter_DataLoadingError(object sender, 
            DataLoadingErrorEventArgs e) {
            foreach(DataLoadingError error in e.Errors)
                Console.WriteLine(
                    $"The following error occurs in {error.DataSourceName}: {error.Error}");
        }
        static void Exporter_DashboardItemDataLoadingError(object sender, 
            DashboardItemDataLoadingErrorEventArgs e) {
            foreach(DashboardItemDataLoadingError error in e.Errors)
                Console.WriteLine(
                    $"The following error occurs in {error.DashboardItemName}: {error.Error}");
        }
    }
}
vb
Imports System
Imports System.IO
Imports DevExpress.DashboardCommon

Namespace DashboardExporterApp
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            If args.Length < 1 OrElse Not Directory.Exists(args(0)) Then
                Console.WriteLine("Path to the dashboard and output folders are required")
                Return
            End If
            Dim dashboards() As String = Directory.GetFiles(args(0), "*.xml")
            Dim outputFolder As String = args(1)
            Dim exporter As New DevExpress.DashboardCommon.DashboardExporter()
            AddHandler exporter.ConnectionError, AddressOf Exporter_ConnectionError
            AddHandler exporter.DataLoadingError, AddressOf Exporter_DataLoadingError
            AddHandler exporter.DashboardItemDataLoadingError, AddressOf Exporter_DashboardItemDataLoadingError
            For Each dashboard As String In dashboards
                Dim outputFile As String = Path.Combine(outputFolder, $"{Path.GetFileNameWithoutExtension(dashboard)}.pdf")
                Using stream = New FileStream(outputFile, FileMode.OpenOrCreate)
                    Try
                        exporter.ExportToPdf(dashboard, stream)
                    Catch e As Exception
                        Console.WriteLine($"Unable to export {dashboard}.")
                        Console.WriteLine(e.Message)
                        Continue For
                    End Try
                End Using
            Next dashboard
            Console.WriteLine("Done!")
        End Sub
        Private Shared Sub Exporter_ConnectionError(ByVal sender As Object, ByVal e As DashboardExporterConnectionErrorEventArgs)
            Console.WriteLine($"The following error occurs in {e.DataSourceName}: {e.Exception.Message}")
        End Sub
        Private Shared Sub Exporter_DataLoadingError(ByVal sender As Object, ByVal e As DataLoadingErrorEventArgs)
            For Each [error] As DataLoadingError In e.Errors
                Console.WriteLine($"The following error occurs in {[error].DataSourceName}: {[error].Error}")
            Next [error]
        End Sub
        Private Shared Sub Exporter_DashboardItemDataLoadingError(ByVal sender As Object, ByVal e As DashboardItemDataLoadingErrorEventArgs)
            For Each [error] As DashboardItemDataLoadingError In e.Errors
                Console.WriteLine($"The following error occurs in {[error].DashboardItemName}: {[error].Error}")
            Next [error]
        End Sub
    End Class
End Namespace

Example: How to Use MailKit to Send a Dashboard as a Document in PDF

This example demonstrates how to email a dashboard with the MailKit email client library. To email a document to a specific address, run the application, enter the SMTP host, port, SMTP credentials, and click Send.

View Example

Example: How to Email a Dashboard that Displays Different Data Depending on the Addressee

The following example shows how to use the DashboardExporter component in a console application to email a dashboard that displays different data depending on the addressee. The MailKit email client library is used in this example.

View Example

Implement Server-Side Export

The ASPxDashboardExporter class allows you to implement server export for the ASP.NET Web Forms Dashboard Control. It uses information stored in a dashboard state to determine the currently selected filters, drill-down levels, and parameter values. The state overrides default values specified in dashboard items and parameters. Export methods allow you to specify a dashboard state and export options for the resulting document. Refer to the ASPxDashboardExporter class description for more information.

This example demonstrates how to export a dashboard displayed in ASPxDashboard on the server side using the ASPxDashboardExporter class. The following API is used to implement this capability.

View Example

csharp
using DevExpress.DashboardCommon;
using DevExpress.DashboardWeb;
using System;
using System.Collections.Generic;
using System.IO;
using System.Web.Hosting;

namespace ASPxDashboard_ServerExport {
    public partial class Default : System.Web.UI.Page {
        DashboardFileStorage fileStorage = new DashboardFileStorage("App_Data/Dashboards");
        protected void Page_Load(object sender, EventArgs e) {
            ASPxDashboard1.AllowExportDashboard = false;         
            ASPxDashboard1.SetDashboardStorage(fileStorage);
        }

        protected void ASPxDashboard1_CustomJSProperties(object sender, DevExpress.Web.CustomJSPropertiesEventArgs e){
            List<string> dashboardIDs = new List<string>();
            foreach (DashboardInfo dashboardInfo in ((IDashboardStorage)fileStorage).GetAvailableDashboardsInfo()) {
                dashboardIDs.Add(dashboardInfo.ID);
            }
            e.Properties.Add("cpGetDashboardIDs", dashboardIDs);
        }

        protected void ASPxDashboard1_CustomDataCallback(object sender, DevExpress.Web.CustomDataCallbackEventArgs e) {
            using (MemoryStream stream = new MemoryStream()) {
                string selectedDashboardID = e.Parameter.Split('|')[0];
                string dashboardStateJson = e.Parameter.Split('|')[1];
                DashboardState dashboardState = new DashboardState();
                dashboardState.LoadFromJson(dashboardStateJson);

                DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
                pdfOptions.ExportFilters = true;
                pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below;

                string serverPath = Environment.GetFolderPath(Environment.SpecialFolder.Desktop);
                if (!Directory.Exists(serverPath)) {
                    Directory.CreateDirectory(serverPath);
                }                

                string dateTimeNow = DateTime.Now.ToString("yyyyMMddHHmmss");
                string filePath = serverPath + "\\" + selectedDashboardID + "_" + dateTimeNow + ".pdf";
                ASPxDashboardExporter exporter = new ASPxDashboardExporter(ASPxDashboard1);
                exporter.ExportToPdf(selectedDashboardID, stream, new System.Drawing.Size(1920, 1080), dashboardState, pdfOptions);
                SaveFile(stream, filePath);
                e.Result = filePath;
            }
        }

        private void SaveFile(MemoryStream stream, string path) {
            var fileStream = File.Create(path);
            stream.WriteTo(fileStream);  
            fileStream.Close();
        }
    }
}
vb
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWeb
Imports System
Imports System.Collections.Generic
Imports System.IO

Namespace ASPxDashboard_ServerExport

    Public Partial Class [Default]
        Inherits Web.UI.Page

        Private fileStorage As DashboardFileStorage = New DashboardFileStorage("App_Data/Dashboards")

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            ASPxDashboard1.AllowExportDashboard = False
            ASPxDashboard1.SetDashboardStorage(fileStorage)
        End Sub

        Protected Sub ASPxDashboard1_CustomJSProperties(ByVal sender As Object, ByVal e As DevExpress.Web.CustomJSPropertiesEventArgs)
            Dim dashboardIDs As List(Of String) = New List(Of String)()
            For Each dashboardInfo As DashboardInfo In CType(fileStorage, IDashboardStorage).GetAvailableDashboardsInfo()
                dashboardIDs.Add(dashboardInfo.ID)
            Next

            e.Properties.Add("cpGetDashboardIDs", dashboardIDs)
        End Sub

        'Protected Sub ASPxDashboard1_CustomDataCallback(ByVal sender As Object, ByVal e As DevExpress.Web.CustomDataCallbackEventArgs)
        ' Using stream As MemoryStream = New MemoryStream()
        ' Dim selectedDashboardID As String = e.Parameter.Split("|"c)(0)
        ' Dim dashboardStateJson As String = e.Parameter.Split("|"c)(1)
        ' Dim dashboardState As DashboardState = New DashboardState()
        ' dashboardState.LoadFromJson(dashboardStateJson)
        ' Dim pdfOptions As DashboardPdfExportOptions = New DashboardPdfExportOptions()
        ' pdfOptions.ExportFilters = True
        ' pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below
        ' Dim dateTimeNow As String = Date.Now.ToString("yyyyMMddHHmmss")
        ' Dim filePath As String = "~/App_Data/Export/" & selectedDashboardID & "_" & dateTimeNow & ".pdf"
        ' Dim exporter As ASPxDashboardExporter = New ASPxDashboardExporter(ASPxDashboard1)
        ' exporter.ExportToPdf(selectedDashboardID, stream, New System.Drawing.Size(1920, 1080), dashboardState, pdfOptions)
        ' SaveFile(stream, filePath)
        ' e.Result = filePath
        ' End Using
        'End Sub
        Protected Sub ASPxDashboard1_CustomDataCallback(ByVal sender As Object, ByVal e As DevExpress.Web.CustomDataCallbackEventArgs)
            Using stream As New MemoryStream()
                Dim selectedDashboardID As String = e.Parameter.Split("|"c)(0)
                Dim dashboardStateJson As String = e.Parameter.Split("|"c)(1)
                Dim dashboardState As New DashboardState()
                dashboardState.LoadFromJson(dashboardStateJson)

                Dim pdfOptions As New DashboardPdfExportOptions()
                pdfOptions.ExportFilters = True
                pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below

                Dim serverPath As String = Environment.GetFolderPath(Environment.SpecialFolder.Desktop)
                If Not Directory.Exists(serverPath) Then
                    Directory.CreateDirectory(serverPath)
                End If

                Dim dateTimeNow As String = Date.Now.ToString("yyyyMMddHHmmss")
                Dim filePath As String = serverPath & "\" & selectedDashboardID & "_" & dateTimeNow & ".pdf"
                Dim exporter As New ASPxDashboardExporter(ASPxDashboard1)
                exporter.ExportToPdf(selectedDashboardID, stream, New System.Drawing.Size(1920, 1080), dashboardState, pdfOptions)
                SaveFile(stream, filePath)
                e.Result = filePath
            End Using
        End Sub

        Private Sub SaveFile(ByVal stream As MemoryStream, ByVal path As String)
            Dim fileStream = File.Create(path)
            stream.WriteTo(fileStream)
            fileStream.Close()
        End Sub
    End Class
End Namespace
aspx
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="ASPxDashboard_ServerExport.Default" %>

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

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">

    <div id="selectBox" style="float: left;"></div>
    <div id="buttonContainer" style="float: left; margin-left: 150px;"></div>
    <div style="position: absolute; left: 0; right: 0; top:50px; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%" WorkingMode="Viewer"
            ClientInstanceName="webDashboard"
            OnCustomDataCallback="ASPxDashboard1_CustomDataCallback" 
            OnCustomJSProperties="ASPxDashboard1_CustomJSProperties">
             <ClientSideEvents 
                 BeforeRender="function(s, e) { onBeforeRender(s,e); }"
                 CustomDataCallback="function(s, e) { dashboardExportedSuccess(e); }"/>  
            </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%= Page.ResolveClientUrl("~/Scripts/InitializeControls.js") %>"></script>
aspx
<%@ Page Language="VB" AutoEventWireup="true" CodeBehind="Default.aspx.vb" Inherits="ASPxDashboard_ServerExport.Default" %>

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

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">

    <div id="selectBox" style="float: left;"></div>
    <div id="buttonContainer" style="float: left; margin-left: 150px;"></div>
    <div style="position: absolute; left: 0; right: 0; top:50px; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%" WorkingMode="Viewer"
            ClientInstanceName="webDashboard"
            OnCustomDataCallback="ASPxDashboard1_CustomDataCallback" 
            OnCustomJSProperties="ASPxDashboard1_CustomJSProperties">
             <ClientSideEvents 
                 BeforeRender="function(s, e) { onBeforeRender(s,e); }"
                 CustomDataCallback="function(s, e) { dashboardExportedSuccess(e); }"/>  
            </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%= Page.ResolveClientUrl("~/Scripts/InitializeControls.js") %>"></script>
js
function onBeforeRender(s,e) {
    var dashboardControl = s.GetDashboardControl();
    $("#buttonContainer").dxButton({
        text: "Export to PDF",
        onClick: function (param) {
            var selectedDashboardID = dashboardControl.getDashboardId();
            var dashboardState = dashboardControl.getDashboardState();
            var parameters = selectedDashboardID + "|" + dashboardState;
            webDashboard.PerformDataCallback(parameters, null);
        }
    });

    $("#selectBox").dxSelectBox({
        dataSource: getDashboardIDs(),
        value: getDashboardIDs()[0],
        onValueChanged: function (param) {
            dashboardControl.loadDashboard(param.value);
        }
    });
}

function getDashboardIDs() {
    return webDashboard.cpGetDashboardIDs;
};

function dashboardExportedSuccess(args) {
    DevExpress.ui.notify('A dashboard was exported to ' + args.result, 'success', 5000);
};

Client-Side API

You can use the Web Dashboard’s client-side API for exporting to various formats, customizing export options, etc. For this, use the members of the DashboardExportExtension:

exportToPdfExports the entire dashboard to a PDF file.exportToImageExports the entire dashboard to an image.exportToExcelExports the entire dashboard to an Excel file.exportDashboardItemToPdf(itemName)Exports a dashboard item to a PDF file.exportDashboardItemToImage(itemName)Exports a dashboard item to an image.exportDashboardItemToExcel(itemName)Exports a dashboard item to an Excel file.getPdfExportOptionsReturns options related to exporting a dashboard/dashboard item to PDF format.getImageExportOptionsReturns options related to exporting a dashboard/dashboard item to the Image format.getExcelExportOptionsReturns options related to exporting a dashboard/dashboard item to Excel format.setPdfExportOptions(options)Sets options related to exporting a dashboard/dashboard item to PDF format.setImageExportOptions(options)Sets options related to exporting a dashboard/dashboard item to the Image format.setExcelExportOptions(options)Sets options related to exporting a dashboard/dashboard item to Excel format.showExportDashboardDialog(format)Invokes the dialog that allows end-users to export the entire dashboard to the specified format.showExportDashboardItemDialog(itemComponentName, format)Invokes the dialog that allows end users to export the dashboard item to the specified format.

Custom Export

The Dashboard Control raises the ASPxDashboard.CustomExport/DashboardConfigurator.CustomExport event before saving the exported document to the PDF and Image formats. The event allows you to customize the exported document.

The following table illustrates dashboard items and their corresponding printable XRControls:

Dashboard ItemXRControl
ChartDashboardItemXRChart
ScatterChartDashboardItemXRChart
PieDashboardItemXRChart
PivotDashboardItemXRPivotGrid
RangeFilterDashboardItem (When CustomExportBaseEventArgs.ExportMode is SingleItem)XRChart
GaugeDashboardItemXRGaugeDashboardItem
TextBoxDashboardItemXRTextBox

Example: How to Customize Dashboard Items in the Exported Document

The following example shows how to customize dashboard items in the exported document when you handle the ASPxDashboard.CustomExport / DashboardConfigurator.CustomExport events. You can use the CustomExportWebEventArgs.GetPrintableControls method to obtain the printable controls.

csharp
using DevExpress.DashboardCommon;
using DevExpress.DashboardWeb;
using DevExpress.XtraCharts;
using DevExpress.XtraReports.UI;
using System;
using System.Drawing;
using System.Linq;

protected void CustomizeExport(object sender, CustomExportWebEventArgs e) {
  foreach(var printControl in e.GetPrintableControls()) {
    if(printControl.Value is XRGaugeDashboardItem) {
      var gaugeItemName = printControl.Key;
      var gaugeDashboardItem = e.GetDashboardItem(gaugeItemName) as GaugeDashboardItem;
      foreach(var dashGaugeElement in gaugeDashboardItem.Gauges) {
        foreach(var gaugePanel in e.GetGaugeContext(gaugeItemName).GetPrintableGauges(dashGaugeElement).Cast<XRDashboardGauge>()) {
          if(gaugePanel != null) {
              gaugePanel.MainSeriesLabel.ForeColor = Color.Red;
          }
        }
      }
    }

    if(printControl.Value is XRChart) {
      var chartItemName = printControl.Key;
      var chartDashboardItem = e.GetDashboardItem(chartItemName) as ChartDashboardItem;
      foreach(var pane in chartDashboardItem.Panes) {
        if(pane.Series.Count > 0) {
          foreach(var dashSeries in pane.Series) {
            if(dashSeries != null) {
              var controlSeries = e.GetChartContext(chartItemName).GetControlSeries(dashSeries);
              if(controlSeries != null) {
                foreach(var ser in controlSeries) {
                  LineSeriesView view = ser.View as LineSeriesView;
                  if(view != null) {
                      view.LineStyle.DashStyle = DashStyle.DashDot;
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
vb
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWeb
Imports DevExpress.XtraCharts
Imports DevExpress.XtraReports.UI
Imports System
Imports System.Drawing
Imports System.Linq

Protected Sub ASPxDashboard1_CustomExport(ByVal sender As Object, ByVal e As CustomExportWebEventArgs)
  For Each printControl In e.GetPrintableControls()
    If TypeOf printControl.Value Is XRGaugeDashboardItem Then
      Dim gaugeItemName = printControl.Key
      Dim gaugeDashboardItem = TryCast(e.GetDashboardItem(gaugeItemName), GaugeDashboardItem)
      For Each dashGaugeElement In gaugeDashboardItem.Gauges
        For Each gaugePanel In e.GetGaugeContext(gaugeItemName).GetPrintableGauges(dashGaugeElement).Cast(Of XRDashboardGauge)()
          If gaugePanel IsNot Nothing Then
              gaugePanel.MainSeriesLabel.ForeColor = Color.Red
          End If
        Next gaugePanel
      Next dashGaugeElement
    End If

    If TypeOf printControl.Value Is XRChart Then
      Dim chartItemName = printControl.Key
      Dim chartDashboardItem = TryCast(e.GetDashboardItem(chartItemName), ChartDashboardItem)
      For Each pane In chartDashboardItem.Panes
        If pane.Series.Count > 0 Then
          For Each dashSeries In pane.Series
            If dashSeries IsNot Nothing Then
              Dim controlSeries = e.GetChartContext(chartItemName).GetControlSeries(dashSeries)
              If controlSeries IsNot Nothing Then
                For Each ser In controlSeries
                  Dim view As LineSeriesView = TryCast(ser.View, LineSeriesView)
                  If view IsNot Nothing Then
                      view.LineStyle.DashStyle = DashStyle.DashDot
                  End If
                Next ser
              End If
            End If
          Next dashSeries
        End If
      Next pane
    End If
  Next printControl
End Sub

Example: How to Add Custom Information to the Exported Dashboard

The following example shows how to specify header and footer content of an exported dashboard. For this, the CustomExport event is used.

View Example: ASP.NET Web Forms

Example: How to Add a Custom Header to Each Sheet

The following example shows how to add a custom header to each sheet for the exported Excel workbook. For this, the CustomizeExportDocument event is used.

View Example: ASP.NET Web Forms

Example: How to export the Dashboard to PDF with Different Filter Values on Different Pages

The following example shows how to export a dashboard with different dashboard states (different master filter value) to separate pages and join them to a single PDF document. Multiple exported documents are joined in a single file with the help of the PdfDocumentProcessor class.

View Example: ASP.NET Web Forms

Example: Non-Visual Custom Export

This example shows how to use the DashboardExporter component in a console application to export a dashboard with a custom Funnel item.

View Example

See Also

ASPxDashboardExporter

Exporting in the Web Dashboard