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

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

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void ExportDashboardItemToPdf(
    Stream dashboardXml,
    string dashboardItemName,
    Stream outputStream,
    Size? dashboardItemSize = null,
    DashboardState state = null,
    DashboardPdfExportOptions options = null
)

VB.NET

Public Sub ExportDashboardItemToPdf(
    dashboardXml As Stream,
    dashboardItemName As String,
    outputStream As Stream,
    dashboardItemSize As Size? = Nothing,
    state As DashboardState = Nothing,
    options As DashboardPdfExportOptions = Nothing
)

Parameters

Name	Type	Description
dashboardXml	Stream	A stream that contains the dashboard from which the dashboard item’s data is exported.
dashboardItemName	String	The component name of the dashboard item.
outputStream	Stream	A stream to which the created PDF file should be sent.

Optional Parameters

Name	Type	Default	Description
dashboardItemSize	Nullable<Size>	null	A dashboard item’s size set 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.