Skip to main content

ASPxClientVerticalGrid.BatchEditStartEditing Event

Occurs when a grid switches to batch edit mode.

#Declaration

TypeScript
BatchEditStartEditing: ASPxClientEvent<ASPxClientVerticalGridBatchEditStartEditingEventHandler<ASPxClientVerticalGrid>>

#Event Data

The BatchEditStartEditing event's data class is ASPxClientVerticalGridBatchEditStartEditingEventArgs. The following properties provide information specific to this event:

Property Description
cancel Specifies whether to cancel the related action (for example, row edit, export). Inherited from ASPxClientCancelEventArgs.
focusedRow Gets the grid row that owns a cell that is about to be edited.
recordValues Gets a hashtable that maintains information about editable cells.
visibleIndex Gets the visible index of the record whose cells are about to be edited.

#Remarks

The BatchEditStartEditing event is raised when the grid enters the edit mode due to an end-user interaction or programmatic call to the ASPxClientVerticalGridBatchEditApi.StartEdit method. The event provides arguments that allow you to prevent switching a particular cell to the edit mode.

function Grid_BatchEditStartEditing(s, e) {
   ...
   e.cancel = true;
}
See Also