ASP.NET MVC Controls | ComponentOne
In This Topic
    FormatItemEventArgs Class
    In This Topic
    File
    wijmo.grid.js
    Module
    wijmo.grid
    Base Class
    CellRangeEventArgs

    Provides arguments for the FlexGrid.formatItem event.

    Constructor

    Properties

    Methods

    Events

    Constructor

    constructor

    constructor(p: GridPanel, rng: CellRange, cell: HTMLElement, updateContent?: boolean): FormatItemEventArgs

    Initializes a new instance of the FormatItemEventArgs class.

    Parameters
    • p: GridPanel

      GridPanel that contains the range.

    • rng: CellRange

      Range of cells affected by the event.

    • cell: HTMLElement

      Element that represents the grid cell to be formatted.

    • updateContent: boolean Optional

      Whether to set the cell content in addition to its dimensions and styles.

    Returns
    FormatItemEventArgs

    Properties

    cancel

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

    Inherited From
    CancelEventArgs
    Type
    boolean

    cell

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

    Type
    HTMLElement

    col

    Gets the index of the column affected by this event.

    To get the Column object, use the getColumn method.

    Inherited From
    CellRangeEventArgs
    Type
    number

    data

    Gets or sets the data associated with the event.

    Inherited From
    CellRangeEventArgs
    Type
    any

    panel

    Gets the GridPanel affected by this event.

    Inherited From
    CellRangeEventArgs
    Type
    GridPanel

    range

    Gets the CellRange affected by this event.

    Inherited From
    CellRangeEventArgs
    Type
    CellRange

    row

    Gets the index of the row affected by this event.

    To get the Row object, use the getRow method.

    Inherited From
    CellRangeEventArgs
    Type
    number

    updateContent

    Gets a value that determines whether the handler should set the cell content in addition to its dimensions and styles.

    Type
    boolean

    Methods

    getColumn

    getColumn(binding?: boolean): Column

    Gets the Column affected by this event.

    To get the column index, use the col property.

    Parameters
    • binding: boolean Optional

      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).

    Inherited From
    CellRangeEventArgs
    Returns
    Column

    getRow

    getRow(): Row

    Gets the Row affected by this event.

    To get the row index, use the row property.

    Inherited From
    CellRangeEventArgs
    Returns
    Row

    Events

    Static empty

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

    Inherited From
    EventArgs
    Arguments
    EventArgs