ComponentOne ASP.NET MVC Controls
IFlexGridXlsxOptions Interface
File
wijmo.grid.xlsx.js
Module
wijmo.grid.xlsx

FlexGrid Xlsx conversion options

Properties

Properties

activeWorksheet

Index or name of the active sheet in the xlsx file.

Type
any

formatItem

An optional callback which is called for every exported cell and allows to perform transformations of exported cell value and style. The callback is called irrespectively of the 'includeCellStyles' property value. It has a single parameter of the XlsxFormatItemEventArgs type that provides both information about the source grid cell and an IWorkbookCell object defining its representation in the exported file, which can be customized in the callback.

Type

includeCellStyles

Indicates whether cells styling should be included in the generated xlsx file.

Type
boolean

includeColumnHeaders

Indicates whether to include column headers as first rows in the generated xlsx file.

Type
boolean

includeColumns

A callback to indicate which columns of FlexGrid need be included or omitted during exporting.

For example:

// This sample excludes the 'country' column from export.
 

// JavaScript
wijmo.grid.xlsx.FlexGridXlsxConverter.save(grid, {
  includeColumns: function(column) {
     return column.binding !== 'country';
  }
}
Type

includeRowHeaders

Indicates whether to include column headers as first rows in the generated xlsx file.

Type
boolean

sheetIndex

The index of the sheet in the workbook. It indicates to import which sheet.

Type
number

sheetName

The name of the sheet. It indicates to import which sheet for importing. If the sheetIndex and sheetName are both setting, the priority of sheetName is higher than sheetIndex. It sets the name of worksheet for exporting.

Type
string

sheetVisible

The visible of the sheet.

Type
boolean