cpr.events.CGridEventOptions

Hierarchy

Index

Properties
Name Type Description
cancelable Boolean Whether the event can be canceled with preventDefault().
cellBoundingRect Rectangle The actual drawn size of the detail cell where the event occurred.
cellIndex Number Cell index where the event occurred.
columnName String The columnName of the cell where the event occurred.
data Object Data passed through events.
groupBandName "gfooter" | "gheader" The band name of the grid group where the event occurred.
isCommit Boolean Whether to reflect the data being edited.
newSelection Object Current selected or edited row information.
newValue Object current value.
oldSelection Object Row information previously selected or edited.
oldValue Object Value before change.
relativeTargetName "detail" | "footer" | "header" | "rowgroup" The name of the target in the grid where the event occurred.
row GridRow The GridRow object on which the event occurred.
rowIndex Number The data row index of the row where the event occurred.
rowgroup GridRowGroup The currently clicked GridRowGroup object.
userData Object For custom events, the payload data object.
viewRowIndex Number The view row index of the row where the event occurred.

Properties

cancelable
declaring type CEventOption
type Boolean
Whether the event can be canceled with preventDefault(). This option works only when there is no nativeEvent.
cellBoundingRect
type Rectangle
The actual drawn size of the detail cell where the event occurred.
cellIndex
type Number
Cell index where the event occurred.
columnName
type String
The columnName of the cell where the event occurred.
data
type Object
Data passed through events.
groupBandName
type "gfooter" | "gheader"
The band name of the grid group where the event occurred.
gheader, gfooter
isCommit
type Boolean
Whether to reflect the data being edited.
(used in the before-editrow-change event)
newSelection
type Object
Current selected or edited row information.
(index array or cellPosition array or GridRow object)
newValue
type Object
current value.
oldSelection
type Object
Row information previously selected or edited.
(index array or cellPosition array or GridRow object)
oldValue
type Object
Value before change.
relativeTargetName
deprecatedPlease use relativeTargetBandName.
type "detail" | "footer" | "header" | "rowgroup"
The name of the target in the grid where the event occurred.
header, detail, footer, rowgroup
row
type GridRow
The GridRow object on which the event occurred.
rowIndex
type Number
The data row index of the row where the event occurred.
rowgroup
type GridRowGroup
The currently clicked GridRowGroup object. (used in rowgroup-click, rowgroup-dblclick events)
userData
declaring type CEventOption
type Object
For custom events, the payload data object.
viewRowIndex
type Number
The view row index of the row where the event occurred.