DashboardExporter.ExportDashboardItemToImage(String, String, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Method

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

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void ExportDashboardItemToImage(
    string dashboardXmlPath,
    string dashboardItemName,
    Stream outputStream,
    Size? dashboardItemSize = null,
    DashboardState state = null,
    DashboardImageExportOptions options = null
)

VB.NET

Public Sub ExportDashboardItemToImage(
    dashboardXmlPath As String,
    dashboardItemName As String,
    outputStream As Stream,
    dashboardItemSize As Size? = Nothing,
    state As DashboardState = Nothing,
    options As DashboardImageExportOptions = Nothing
)

Parameters

Name	Type	Description
dashboardXmlPath	String	The path to the dashboard XML file.
dashboardItemName	String	The component name of the dashboard item.
outputStream	Stream	A stream to which the created Image 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	DashboardImageExportOptions	null	A DashboardImageExportOptions object that contains Image-specific options.