ASPxClientTreeList.BatchEditStartEditing Event

Occurs when a tree list switches to batch edit mode.

Declaration

BatchEditStartEditing: ASPxClientEvent<ASPxClientTreeListBatchEditStartEditingEventHandler<ASPxClientTreeList>>

Event Data

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

Property	Description
cancel	Gets or sets a value indicating whether the action which raised the event should be canceled. Inherited from ASPxClientCancelEventArgs.
focusedColumn	Gets the tree list column that owns a cell that is about to be edited.
nodeKey	Gets the node’s key value.
nodeValues	Gets the value of the processed cell.

Remarks

The BatchEditStartEditing event is raised when the tree list enters the edit mode (for a cell/node) due to an end-user interaction or programmatic call to the ASPxClientTreeListBatchEditApi.StartEdit method. The event provides arguments that allow you to prevent switching a particular cell to the edit mode.

When the TreeListBatchEditSettings.EditMode property is set to Cell, you can set the ASPxClientCancelEventArgs.cancel argument to true to prevent editing the current cell.

JS

function TreeList_BatchEditStartEditing(s, e) {
   ...
   e.cancel = true;
}

When the TreeListBatchEditSettings.EditMode property is set to Node, you can prevent switching particular cells to edit mode using the ASPxClientTreeListBatchEditStartEditingEventArgs.nodeValues event argument. This is a hashtable that maintains information about editable cells. You can prevent displaying editors for particular cells by removing the corresponding entries from nodeValues.