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

    Represents arguments of the IFlexGridXlsxOptions.formatItem callback.

    Constructor

    constructor

    constructor(p: GridPanel, rng: CellRange, data?: any): CellRangeEventArgs
    

    Initializes a new instance of the CellRangeEventArgs class.

    Parameters
    • p: GridPanel

      GridPanel that contains the range.

    • rng: CellRange

      Range of cells affected by the event.

    • data: any Optional

      Data related to the event.

    Inherited From
    CellRangeEventArgs
    Returns
    CellRangeEventArgs

    Properties

    cancel

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

    Inherited From
    CancelEventArgs
    Type
    boolean

    cell

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

    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

    xlsxCell

    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.

    Type
    IWorkbookCell

    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

    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 (includeStyles=false), but you need to export a custom content and/or style for a certain cells.

    Returns
    HTMLElement

    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