ASPxClientVerticalGridBatchEditApi.SetCellValue(visibleIndex, rowFieldNameOrId, value) Method
Sets the value of the specified cell.
Declaration
SetCellValue(
visibleIndex: number,
rowFieldNameOrId: string,
value: any,
displayText?: string,
cancelCellHighlighting?: boolean
): void
Parameters
Name | Type | Description |
---|---|---|
visibleIndex | number | An integer zero-based index that identifies the row containing the processed cell. |
rowFieldNameOrId | string | A string value that specifies the field name or unique identifier (the column’s WebColumnBase.Name property value) of a column containing the processed cell. |
value | any | An object that contains the new cell value. |
displayText | string | A string value that specifies the cell display text. |
cancelCellHighlighting | boolean | true to cancel highlighting of the modified cell, false to highlight the modified cell. |
Remarks
Use the SetCellValue property to change the value of the specified cell when the latter is not in edit mode.
Note
The SetCellValue method is not in effect in the following situations:
- If the row’s GridColumnEditFormSettings.Visible property is set to false.
If the cell is in edit mode. It is necessary to use the ASPxClientVerticalGrid.BatchEditEndEditing event handler to change the cell value:
function onBatchEditEndEditing(s,e) { e.recordValues[rowIndex].value = newValue; e.recordValues[rowIndex].text = displayText; }