WebDashboardExporter.ExportToPdf(String, Stream, Size, DashboardState, DashboardPdfExportOptions) Method

Exports a dashboard to the specified stream in PDF format.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v23.2.Web.dll

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void ExportToPdf(
    string dashboardId,
    Stream stream,
    Size dashboardSize,
    DashboardState state,
    DashboardPdfExportOptions options
)

VB.NET

Public Sub ExportToPdf(
    dashboardId As String,
    stream As Stream,
    dashboardSize As Size,
    state As DashboardState,
    options As DashboardPdfExportOptions
)

Parameters

Name	Type	Description
dashboardId	String	A String that specifies the identifier of a dashboard to be exported.
stream	Stream	A Stream object to which the created PDF file should be sent.
dashboardSize	Size	A Size object that specifies the dashboard size.
state	DashboardState	A DashboardState object that specifies the dashboard state to be applied to the resulting document.
options	DashboardPdfExportOptions	A DashboardPdfExportOptions object containing PDF-specific options.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToPdf(String, Stream, 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#

web-forms-dashboard-implement-server-side-export/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L43

ASPxDashboardExporter exporter = new ASPxDashboardExporter(ASPxDashboard1);
exporter.ExportToPdf(selectedDashboardID, stream, new System.Drawing.Size(1920, 1080), dashboardState, pdfOptions);
SaveFile(stream, filePath);

web-forms-dashboard-pdf-export-with-filter-values-on-different-pages/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L40

{
    exporter.ExportToPdf("Dashboard", stream, new System.Drawing.Size(1024, 768), dashboardState, pdfOptions);
    documentProcessor.AppendDocument(stream);

asp-net-mvc-dashboard-implement-server-side-export/CS/MvcDashboard_ServerExport/Controllers/HomeController.cs#L35

var exporter = new WebDashboardExporter(DashboardConfigurator.Default);
exporter.ExportToPdf(dashboardID, stream, new System.Drawing.Size(1024, 768), dashboardState, pdfOptions);
SaveFile(stream, filePath + uniqueId);

VB.NET

web-forms-dashboard-implement-server-side-export/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L64

Dim exporter As New ASPxDashboardExporter(ASPxDashboard1)
exporter.ExportToPdf(selectedDashboardID, stream, New System.Drawing.Size(1920, 1080), dashboardState, pdfOptions)
SaveFile(stream, filePath)

web-forms-dashboard-pdf-export-with-filter-values-on-different-pages/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L39

Using stream As New MemoryStream()
    exporter.ExportToPdf("Dashboard1", stream, New System.Drawing.Size(1024, 768), dashboardState, pdfOptions)
    documentProcessor.AppendDocument(stream)

asp-net-mvc-dashboard-implement-server-side-export/VB/MvcDashboard_ServerExport/Controllers/HomeController.vb#L32

Dim exporter = New WebDashboardExporter(DashboardConfigurator.Default)
exporter.ExportToPdf(dbID, stream, New System.Drawing.Size(1024, 768), dbState, pdfOptions)
SaveFile(stream, filePath & uniqueId)