ContextQMD
Back to Devexpress

DashboardExcelExportOptions Class

dashboard-devexpress-dot-dashboardcommon-2f56fcc1.md

latest5.6 KB
Original Source

DashboardExcelExportOptions Class

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

Namespace : DevExpress.DashboardCommon

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

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp
public class DashboardExcelExportOptions :
    IDashboardExcelExportOptions,
    IDashboardExportOptions
vb
Public Class DashboardExcelExportOptions
    Implements IDashboardExcelExportOptions,
               IDashboardExportOptions

The following members return DashboardExcelExportOptions objects:

Remarks

The following properties allow you to access default Excel-specific export options for different controls.

Moreover, you can specify Excel options when exporting a dashboard/dashboard item using the following methods.

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.

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

Inheritance

Object DashboardExcelExportOptions

See Also

DashboardExcelExportOptions Members

DevExpress.DashboardCommon Namespace