DashboardExcelExportOptions Class
Contains options related to exporting a dashboard/dashboard item to Excel format.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.2.Core.dll
NuGet Package: DevExpress.Dashboard.Core
#Declaration
public class DashboardExcelExportOptions :
IDashboardExcelExportOptions,
IDashboardExportOptions
#Related API Members
The following members return DashboardExcelExportOptions objects:
#Remarks
The following properties allow you to access default Excel-specific export options for different controls.
- ASPxDashboard.ExcelExportOptions / DashboardExtensionSettings.ExcelExportOptions
- DashboardDesigner.ExcelExportOptions
- DashboardViewer.ExcelExportOptions
- DashboardControl.ExcelExportOptions
Moreover, you can specify Excel options when exporting a dashboard/dashboard item using the following methods.
- WebDashboardExporter.ExportToExcel / WebDashboardExporter.ExportDashboardItemToExcel
- DashboardDesigner.ExportToExcel / DashboardDesigner.ExportDashboardItemToExcel
- DashboardViewer.ExportToExcel / DashboardViewer.ExportDashboardItemToExcel
- DashboardControl.ExportToExcel / DashboardControl.ExportDashboardItemToExcel
Note
To export a dashboard/dashboard item on the web using an API, use Export
#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.
using DevExpress.DashboardCommon;
// ...
dashboardDesigner1.ExportDashboardItemToExcel("chartDashboardItem1", @"c:\temp\ExportedWorkbook.xlsx", new DashboardExcelExportOptions() {
Format = ExcelFormat.Xlsx
}
);