DashboardExcelExportOptions.Format Property

Gets or sets the Excel format in which the dashboard item is exported.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(ExcelFormat.Xlsx)]
public ExcelFormat Format { get; set; }

VB.NET

<DefaultValue(ExcelFormat.Xlsx)>
Public Property Format As ExcelFormat

Property Value

Type	Default	Description
ExcelFormat	Xlsx	An ExcelFormat enumeration member that specifies the Excel format in which the dashboard item is exported.

Available values:

Name	Description
Csv	A comma-separated values (CSV) file format.
Xls	The Excel 97 - Excel 2003 (XLS) file format.
Xlsx	The Office Excel 2007 XML-based (XLSX) file format.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Format
BeforeExportDocumentEventArgs	.ExcelExportOptions .Format
CustomizeExportDocumentEventArgs	.ExcelExportOptions .Format
ASPxDashboard	.ExcelExportOptions .Format
BeforeExportDocumentWebEventArgs	.ExcelExportOptions .Format
CustomizeExportDocumentWebEventArgs	.ExcelExportOptions .Format
DashboardExtensionSettings	.ExcelExportOptions .Format
DashboardDesigner	.ExcelExportOptions .Format
DashboardViewer	.ExcelExportOptions .Format
IDashboardControl	.ExcelExportOptions .Format
DashboardControl	.ExcelExportOptions .Format

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Format property.

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#

web-dashboard-custom-info-exported-excel/CS/WebDashboardForm.aspx.cs#L23

Workbook workbook = new Workbook();
if (e.ExcelExportOptions.Format == ExcelFormat.Xlsx)
    workbook.LoadDocument(e.Stream, DocumentFormat.Xlsx);

VB.NET

web-dashboard-custom-info-exported-excel/VB/WebDashboardForm.aspx.vb#L25

Dim workbook As Workbook = New Workbook()
If e.ExcelExportOptions.Format = ExcelFormat.Xlsx Then
    workbook.LoadDocument(e.Stream, DocumentFormat.Xlsx)

winforms-dashboard-customize-exported-document/VB/CustomExportDocumentExample/Form1.vb#L32

Dim workbook As New Workbook()
If e.ExcelExportOptions.Format = ExcelFormat.Xlsx Then
    workbook.LoadDocument(fileStream, DocumentFormat.Xlsx)