ASP.NET Core MVC Controls | ComponentOne
In This Topic
    IFlexGridXlsxOptions Interface
    In This Topic
    File
    wijmo.grid.xlsx.js
    Module
    wijmo.grid.xlsx

    FlexGrid Xlsx conversion options

    Properties

    Properties

    activeWorksheet

    Export only.

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

    The default value for this option is **undefined** which means that the active sheet is not set.

    Type
    string

    convertHtmlEntities

    Export only.

    Defines the conversion behavior for HTML entities such as """, "<", ">" and "&" when exporting.

    The default value is Auto.

    Type
    HtmlEntityConversion

    formatItem

    Export only.

    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 includeStyles option 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

    Export only.

    Indicates whether cells styling should be included in the generated xlsx file. This option has been deprecated. Please use includeStyles option instead.

    The default value for this option is **true**.

    Type
    boolean

    includeColumnHeaders

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

    The default value for this option is **true**.

    Type
    boolean

    includeColumns

    Export only.

    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.

    The default value for this option is **false**.

    Type
    boolean

    includeStyles

    When importing, indicates whether styles should be imported from xlsx file into a Workbook instance.

    When exporting, indicates whether cells styling should be included in the generated xlsx file.

    The default value for this option is **true**.

    Type
    boolean

    quickCellStyles

    Export only.

    When turned on, decreases the export time by activating the cell styles caching if includeStyles option is enabled. In typical scenarios it allows to decrease the export time by several times.

    The combination of cell's inline style specific properties, own CSS classes and CSS classes of row containing the cell is used as the cache tag. Before the cell style is calculated, the cache is checked first, and if the style associated with the tag is found there, it's taken from there and doesn't get recalculated.

    Using this mode can make the export slower when considerable amount of cells have the unique set of CSS classes and inline styles. Also, when pseudo classes like :first-child and :nth-child are used to style the cells and rows, the cell styles can be determined incorrectly.

    The default value for this option is **true**.

    Type
    boolean

    sheetIndex

    Import only.

    Specifies the index of a sheet to import.

    The default value for this option is **0**.

    Type
    number

    sheetName

    When importing, specifies the name of a sheet to import. The **sheetName** takes priority over the **sheetIndex** option if both options are set.

    When exporting, sets the name of the exported sheet.

    The default value for this option is **undefined**.

    Type
    string

    sheetVisible

    Export only.

    Indicates whether the sheet is visible.

    **Caveat:** This option must be used with care. In case where you generate an xlsx file with a single invisible sheet, such a file can't be opened by Excel. The only scenario where this option can be set to false is where you use multiple export actions to assemble a multi-sheet workbook using a custom code.

    The default value for this option is **true**.

    Type
    boolean