Skip to main content
All docs
V24.1

ExcelFormatOptions Class

Contains options which define how the dashboard item is exported to Excel format.

Declaration

declare class ExcelFormatOptions

Remarks

Use the ASPxClientDashboardExportOptions.ExcelOptions property to access options specific to exporting the dashboard item in Excel format.

Warning

A use of ASPxClientDashboard API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl API to configure the Web Dashboard on the client. More information: Client-Side Functionality.

Properties

CsvValueSeparator Property

Obsolete. Gets or sets a character used to separate values in a CSV document.

Declaration

CsvValueSeparator: string

Property Value

Type Description
string

A string value that specifies the character used to separate values in a CSV document.

Remarks

Note that the CsvValueSeparator property is in effect when the ExcelFormatOptions.Format property is set to DashboardExportExcelFormat.Csv.

Format Property

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

Declaration

Format: string

Property Value

Type Description
string

A value returned by the DashboardExportExcelFormat class that specifies the Excel format in which the dashboard item is exported.