WebDashboardExporter.ExportToExcel(String, Stream, DashboardState, DashboardExcelExportOptions) Method

Exports a dashboard to the specified stream in Excel format.

Namespace: DevExpress.DashboardWeb

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

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void ExportToExcel(
    string dashboardId,
    Stream stream,
    DashboardState state,
    DashboardExcelExportOptions options
)

VB.NET

Public Sub ExportToExcel(
    dashboardId As String,
    stream As Stream,
    state As DashboardState,
    options As DashboardExcelExportOptions
)

Parameters

Name	Type	Description
dashboardId	String	A String that specifies the identifier of a dashboard whose data should be exported.
stream	Stream	A Stream object to which the created Excel file should be sent.
state	DashboardState	A DashboardState object that specifies the dashboard state to be applied to the resulting document.
options	DashboardExcelExportOptions	A DashboardExcelExportOptions object containing Excel-specific options.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToExcel(String, Stream, DashboardState, DashboardExcelExportOptions) 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-integrate-ai-assistant/CS/Controllers/AIChatController.cs#L31

exporter.ExportToExcel(dashboardId, ms, state, new DashboardExcelExportOptions() { ExportParameters = true, ExportFilters = true });