5.20203.748
wijmo.grid Class FormatItemEventArgs Wijmo API Class

FormatItemEventArgs Class

Provides arguments for the FlexGrid.formatItem event.

Heirarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

cancel

cancel: boolean

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

cell

cell: HTMLElement

Gets a reference to the element that represents the grid cell to be formatted.

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.

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

getRow

  • getRow(): Row