DashboardExporter.ExportDashboardItemToExcel(String, String, Stream, DashboardState, DashboardExcelExportOptions) Method

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

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void ExportDashboardItemToExcel(
    string dashboardXmlPath,
    string dashboardItemName,
    Stream outputStream,
    DashboardState state = null,
    DashboardExcelExportOptions options = null
)

VB.NET

Public Sub ExportDashboardItemToExcel(
    dashboardXmlPath As String,
    dashboardItemName As String,
    outputStream As Stream,
    state As DashboardState = Nothing,
    options As DashboardExcelExportOptions = 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 Excel file should be sent.

Optional Parameters

Name	Type	Default	Description
state	DashboardState	null	A DashboardState object that specifies the dashboard state to be applied to the resulting document.
options	DashboardExcelExportOptions	null	A DashboardExcelExportOptions object that contains Excel-specific options.