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

Exports a dashboard item’s data to the specified PDF file.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

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

VB.NET

Public Sub ExportDashboardItemToPdf(
    dashboardXml As Stream,
    dashboardItemName As String,
    outputFilePath As String,
    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.
outputFilePath	String	The path to the output Image file.

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.