GridExcelSettingsBuilder

Methods

AllPages(System.Boolean)

If set to true the grid will export all pages of data. By default the grid exports only the current page.

Parameters

value - System.Boolean

The value for AllPages

RETURNS

Returns the current GridExcelSettingsBuilder instance.

AllPages()

If set to true the grid will export all pages of data. By default the grid exports only the current page.

RETURNS

Returns the current GridExcelSettingsBuilder instance.

FileName(System.String)

Specifies the file name of the exported Excel file. Must end with ".xlsx".

Parameters

value - System.String

The value for FileName

RETURNS

Returns the current GridExcelSettingsBuilder instance.

Filterable(System.Boolean)

Enables or disables column filtering in the Excel file. When set to true the exported Excel file comes with turned on filtering for the column headers. Not to be mistaken with the grid filtering feature.

Parameters

value - System.Boolean

The value for Filterable

RETURNS

Returns the current GridExcelSettingsBuilder instance.

Filterable()

Enables or disables column filtering in the Excel file. When set to true the exported Excel file comes with turned on filtering for the column headers. Not to be mistaken with the grid filtering feature.

RETURNS

Returns the current GridExcelSettingsBuilder instance.

Collapsible(System.Boolean)

Enables or disables collapsible (grouped) rows, for grids with aggregates.

Parameters

value - System.Boolean

The value for Collapsible

RETURNS

Returns the current GridExcelSettingsBuilder instance.

Collapsible()

Enables or disables collapsible (grouped) rows, for grids with aggregates.

RETURNS

Returns the current GridExcelSettingsBuilder instance.

ForceProxy(System.Boolean)

If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.

Parameters

value - System.Boolean

The value for ForceProxy

RETURNS

Returns the current GridExcelSettingsBuilder instance.

ForceProxy()

If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.

RETURNS

Returns the current GridExcelSettingsBuilder instance.

ProxyURL(System.String)

The URL of the server side proxy which will stream the file to the end user.A proxy will be used when the browser isn't capable of saving files locally. Such browsers are IE version 9 and lower and Safari.The developer is responsible for implementing the server-side proxy.The proxy will receive a POST request with the following parameters in the request body: contentType: The MIME type of the file; base64: The base-64 encoded file content or fileName: The file name, as requested by the caller.. The proxy should return the decoded file with the "Content-Disposition" header set toattachment; filename="<fileName.xslx>".

Parameters

value - System.String

The value for ProxyURL

RETURNS

Returns the current GridExcelSettingsBuilder instance.