CellRangeEventArgs Class

In This Topic

File: wijmo.grid.js
Module: wijmo.grid
Base Class: CancelEventArgs
Derived Classes: CellEditEndingEventArgs, FormatItemEventArgs, XlsxFormatItemEventArgs

Provides arguments for CellRange events.

Constructor

constructor

Properties

Methods

Events

empty

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.

Returns: CellRangeEventArgs

Properties

cancel

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

Inherited From: CancelEventArgs
Type: boolean

col

Gets the index of the column affected by this event.

To get the Column object, use the getColumn method.

Type: number

data

Gets or sets the data associated with the event.

Type: any

panel

Gets the GridPanel affected by this event.

Type: GridPanel

range

Gets the CellRange affected by this event.

Type: CellRange

row

Gets the index of the row affected by this event.

To get the Row object, use the getRow method.

Type: number

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

Returns: Column

getRow

getRow(): Row

Gets the Row affected by this event.

To get the row index, use the row property.

Returns: Row

Events

Static empty

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

Inherited From: EventArgs
Arguments: EventArgs