DashboardExcelExportOptions Class

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

Declaration

declare class DashboardExcelExportOptions

Remarks

The ASPxClientDashboard.GetExcelExportOptions and ASPxClientDashboard.SetExcelExportOptions properties allow you to obtain and specify Excel-specific export options on the client side.

You can use the ASPxClientDashboard.ExportToExcel and ASPxClientDashboard.ExportDashboardItemToExcel methods to specify Excel options when exporting a dashboard/dashboard item.

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

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 DashboardExcelExportOptions.Format is set to DashboardExportExcelFormat.Csv.

DashboardStatePosition Property

Gets or sets the position of the dashboard state (such as master filter or current parameter values) in the exported document.

Declaration

DashboardStatePosition: string

Property Value

Type	Description
string	A DashboardStateExcelExportPosition object that specifies the position of the dashboard state in the exported document.

Remarks

To add a master state to the exported document, use the DashboardExcelExportOptions.ExportFilters property. To export current parameter values, enable the DashboardExcelExportOptions.ExportParameters flag.

ExportFilters Property

Gets or sets whether to add the state of master filter items to the exported document.

Declaration

ExportFilters: boolean

Property Value

Type	Description
boolean	true, to add the state of master filter items to the exported document; otherwise, false.

Remarks

To specify the position of the dashboard state (that includes the state of master filter items), use the DashboardExcelExportOptions.DashboardStatePosition property.

ExportParameters Property

Gets or sets whether to add current parameter values to the exported document.

Declaration

ExportParameters: boolean

Property Value

Type	Description
boolean	true, to add current parameter values to the exported document; otherwise, false.

Remarks

To specify the position of the dashboard state (including current parameter values), use the DashboardExcelExportOptions.DashboardStatePosition property.

Format Property

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

Declaration

Format: string

Property Value

Type	Description
string	A DashboardExportExcelFormat value that specifies the Excel format in which the dashboard item is exported.

IncludeHiddenParameters Property

Gets or sets whether to add current values of a hidden parameter to the exported document.

Declaration

IncludeHiddenParameters: boolean

Property Value

Type	Description
boolean	true, to add current values of a hidden parameter to the exported document; otherwise, false.

Remarks

Note that the IncludeHiddenParameters property requires enabling the DashboardExcelExportOptions.ExportParameters property.