DashboardExporter.ExportToPdf(String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Method

Exports a dashboard’s data to the specified stream in PDF format.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public void ExportToPdf(
    string dashboardXmlPath,
    Stream outputStream,
    Size? dashboardSize = null,
    DashboardState state = null,
    DashboardPdfExportOptions options = null
)

VB.NET

Public Sub ExportToPdf(
    dashboardXmlPath As String,
    outputStream As Stream,
    dashboardSize As Size? = Nothing,
    state As DashboardState = Nothing,
    options As DashboardPdfExportOptions = Nothing
)

Parameters

Name	Type	Description
dashboardXmlPath	String	The path to the dashboard XML file.
outputStream	Stream	A stream to which the created PDF file should be sent.

Optional Parameters

Name	Type	Default	Description
dashboardSize	Nullable<Size>	null	The dashboard’s size in pixels.
state	DashboardState	null	A DashboardState object that specifies the dashboard state to be applied to the resulting document.
options	DashboardPdfExportOptions	null	A DashboardPdfExportOptions object that contains PDF-specific options.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToPdf(String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) method.

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.

C#

bi-dashboard-mailkit-export-console-app/CS/ConsoleMailExport/Program.cs#L98

using(MemoryStream stream = new MemoryStream()) {
    exporter.ExportToPdf(
        dashboardXmlPath: "Data/MailDashboard.xml",

bi-dashboard-mailkit-export/CS/SimpleMailExport/Form1.cs#L30

exporter.ExportToPdf("Data/MailDashboard.xml", stream, new System.Drawing.Size(2000, 1000));
stream.Seek(0, System.IO.SeekOrigin.Begin);

VB.NET

bi-dashboard-mailkit-export-console-app/VB/ConsoleMailExport/Program.vb#L88

Using stream As MemoryStream = New MemoryStream()
    exporter.ExportToPdf(dashboardXmlPath:="Data/MailDashboard.xml", outputStream:=stream, dashboardSize:=New System.Drawing.Size(2000, 1000), state:=regionFilterState)
    stream.Seek(0, SeekOrigin.Begin)

bi-dashboard-mailkit-export/VB/SimpleMailExport/Form1.vb#L32

Using stream As MemoryStream = New MemoryStream()
    exporter.ExportToPdf("Data/MailDashboard.xml", stream, New System.Drawing.Size(2000, 1000))
    stream.Seek(0, SeekOrigin.Begin)