Wijmo
Grid
Xlsx
5.20231.904
wijmo.grid.xlsx Class XlsxFormatItemEventArgs Wijmo API Class

XlsxFormatItemEventArgs Class

Represents arguments of the IFlexGridXlsxOptions.formatItem callback.

Heirarchy

Properties

Methods

Properties

cancel

cancel: boolean

Gets or sets a value that indicates whether the event should be canceled.

cell

cell: HTMLElement

If IFlexGridXlsxOptions.includeStyles is set to true then contains a reference to the element that represents the formatted grid cell; otherwise, a null value.

col

col: number

Gets the index of the column affected by this event.

To get the Column object, use the getColumn method.

data

data: any

Gets or sets the data associated with the event.

panel

panel: GridPanel

Gets the GridPanel affected by this event.

range

range: CellRange

Gets the CellRange affected by this event.

row

row: number

Gets the index of the row affected by this event.

To get the Row object, use the getRow method.

xlsxCell

xlsxCell: mXlsx.IWorkbookCell

Contains an exporting cell representation. Initially it contains a default cell representation created by FlexGrid export, and can be modified by the event handler to customize its final content. For example, the xlsxCell.value property can be updated to modify a cell content, xlsxCell.style to modify cell's style, and so on.

Static empty

empty: EventArgs

Provides a value to use with events that do not have event data.

Methods

getColumn

  • getColumn(binding?: boolean): Column

  • Gets the Column affected by this event.

    To get the column index, use the col property.

    Parameters

    • Optional binding: boolean

      Whether to get the column by index or by binding. This parameter only makes a difference in grids that have multiple rows per data item (like the MultiRow grid).

    Returns Column

getFormattedCell

  • getFormattedCell(): HTMLElement

  • Returns a cell with a custom formatting applied (formatItem event, cell templates). This method is useful when export of custom formatting is disabled (IFlexGridXlsxOptions.includeStyles=false), but you need to export a custom content and/or style for a certain cells.

    Returns HTMLElement

getRow

  • getRow(): Row