WebDashboardExporter.ExportDashboardItemToPdf(String, String, Stream, Size, DashboardState) Method

Exports the dashboard item to the specified stream in PDF format.

Namespace: DevExpress.DashboardWeb

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

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void ExportDashboardItemToPdf(
    string dashboardId,
    string dashboardItemName,
    Stream stream,
    Size dashboardItemSize,
    DashboardState state
)

VB.NET

Public Sub ExportDashboardItemToPdf(
    dashboardId As String,
    dashboardItemName As String,
    stream As Stream,
    dashboardItemSize As Size,
    state As DashboardState
)

Parameters

Name	Type	Description
dashboardId	String	A String that specifies the identifier of a dashboard containing the required dashboard item.
dashboardItemName	String	A String that is the component name of the dashboard item to be exported.
stream	Stream	A Stream object to which the created PDF file should be sent.
dashboardItemSize	Size	A Size object that specifies the dashboard item size.
state	DashboardState	A DashboardState object that specifies the dashboard state to be applied to the resulting document.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportDashboardItemToPdf(String, String, Stream, Size, DashboardState) 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#

asp-net-core-dashboard-export-all-items/CS/AspNetCoreDashboard_ExportAllItems/Controllers/ExportController.cs#L33

using (MemoryStream stream = new MemoryStream()) {
    exporter.ExportDashboardItemToPdf(dashboardId, dashboardItemName, stream, new System.Drawing.Size(1024, 768), dashboardState);
    documentProcessor.AppendDocument(stream);