DashboardExcelExportOptions Class

Contains options related to exporting a dashboard/dashboard item to Excel format.

Namespace: DevExpress.DashboardCommon

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

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

public class DashboardExcelExportOptions :
    IDashboardExcelExportOptions,
    IDashboardExportOptions

VB.NET

Public Class DashboardExcelExportOptions
    Implements IDashboardExcelExportOptions,
               IDashboardExportOptions

Related API Members

The following members return DashboardExcelExportOptions objects:

• ASPxDashboard.ExcelExportOptions
• BeforeExportDocumentEventArgs.ExcelExportOptions
• BeforeExportDocumentWebEventArgs.ExcelExportOptions
• CustomizeExportDocumentEventArgs.ExcelExportOptions
• CustomizeExportDocumentWebEventArgs.ExcelExportOptions
• DashboardControl.ExcelExportOptions
• DashboardDesigner.ExcelExportOptions
• DashboardExtensionSettings.ExcelExportOptions
• DashboardViewer.ExcelExportOptions
• IDashboardControl.ExcelExportOptions

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 ExportToExcel / ExportDashboardItemToExcel methods exposed by the ASPxClientDashboard class.

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 _
            })

Inheritance

Object

DashboardExcelExportOptions