Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcGridEditEventArgs

Represents event arguments related to grid editing. The event is cancelable It contains information about the row and the column, as well as the old and nwe value of the element/cell

Constructors

Properties

Constructors

constructor

Properties

cancel

cancel: boolean

Provides the ability to cancel the event.

Optional cellID

cellID?: {
    columnID: any;
    rowID: any;
    rowIndex: number;
}

Type declaration

  • columnID: any
  • rowID: any
  • rowIndex: number

Optional column

column?: IgcColumnComponent

Optional Represents the column information of the edited cell

Optional isAddRow

isAddRow?: boolean

Optional Indicates if the editing consists of adding a new row

Optional newValue

newValue?: any

Optional Represents the value, that is being entered in the edited cell When there is no newValue and the event has ended, the value of the cell returns to the oldValue

oldValue

oldValue: any

Represents the previous (before editing) value of the edited cell. It's used when the event has been stopped/exited.

Optional owner

owner?: IgcGridBaseDirective

Optional Represents the grid instance that owns the edit event.

primaryKey

primaryKey: any

Deprecated

Use the rowKey property instead.

rowData

rowData: any

rowData represents the updated/committed data of the row after the edit (newValue) The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled

rowID

rowID: any

Deprecated

Use the rowKey property instead.

rowKey

rowKey: any

Optional valid

valid?: boolean

Optional Indicates if the new value would be valid. It can be set to return the result of the methods for validation of the grid