DashboardDesigner.ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions) Method

Exports the dashboard item to the specified file in Excel format using specified export options.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public void ExportDashboardItemToExcel(
    string dashboardItemName,
    string filePath,
    DashboardExcelExportOptions options
)

VB.NET

Public Sub ExportDashboardItemToExcel(
    dashboardItemName As String,
    filePath As String,
    options As DashboardExcelExportOptions
)

Parameters

Name	Type	Description
dashboardItemName	String	A String that is the component name of the dashboard item to be exported.
filePath	String	A String that specifies the path to the Excel file.
options	DashboardExcelExportOptions	A DashboardExcelExportOptions object which specifies the Excel export options to be applied when the dashboard item is exported.

Example

The following code snippet shows how to export data visualized within the Chart dashboard item using the DashboardDesigner.ExportDashboardItemToExcel method in the XLSX format.

C#

using DevExpress.DashboardCommon;
// ...
            dashboardDesigner1.ExportDashboardItemToExcel("chartDashboardItem1", @"c:\temp\ExportedWorkbook.xlsx", new DashboardExcelExportOptions() {
                    Format = ExcelFormat.Xlsx
                }   
            );

VB.NET

Imports DevExpress.DashboardCommon
' ...
            dashboardDesigner1.ExportDashboardItemToExcel("chartDashboardItem1", "c:\temp\ExportedWorkbook.xlsx", New DashboardExcelExportOptions() With { _
                Key .Format = ExcelFormat.Xlsx _
            })

Implements

ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions)