Skip to main content

BootstrapGridViewBatchEditApi Class

In This Article

#Declaration

TypeScript
class BootstrapGridViewBatchEditApi

#Remarks

IMPORTANT

Bootstrap Controls for ASP.NET Core are in maintenance mode. We don’t add new controls or develop new functionality for this product line. Our recommendation is to use the ASP.NET Core Controls suite.

#Methods

#addNewRow Method

#Declaration

TypeScript
addNewRow(): void

#deleteRow(visibleIndex) Method

#Declaration

TypeScript
deleteRow(
    visibleIndex: number
): void

#Parameters

Name Type
visibleIndex number

#deleteRowByKey(key) Method

#Declaration

TypeScript
deleteRowByKey(
    key: any
): void

#Parameters

Name Type
key any

#endEdit Method

#Declaration

TypeScript
endEdit(): void

#getCellTextContainer(visibleIndex, columnFieldNameOrId) Method

#Declaration

TypeScript
getCellTextContainer(
    visibleIndex: number,
    columnFieldNameOrId: string
): any

#Parameters

Name Type
visibleIndex number
columnFieldNameOrId string

#Returns

Type
any

#getCellValue(visibleIndex, columnFieldNameOrId, initial) Method

#Declaration

TypeScript
getCellValue(
    visibleIndex: number,
    columnFieldNameOrId: string,
    initial: boolean
): any

#Parameters

Name Type
visibleIndex number
columnFieldNameOrId string
initial boolean

#Returns

Type
any

#getColumnDisplayText(columnFieldNameOrId, value) Method

#Declaration

TypeScript
getColumnDisplayText(
    columnFieldNameOrId: string,
    value: any
): string

#Parameters

Name Type
columnFieldNameOrId string
value any

#Returns

Type
string

#getDeletedRowIndices Method

#Declaration

TypeScript
getDeletedRowIndices(): number[]

#Returns

Type
number[]

#getEditCellInfo Method

#Declaration

TypeScript
getEditCellInfo(): BootstrapGridViewCellInfo | null

#Returns

Type
BootstrapGridViewCellInfo
null

#getInsertedRowIndices Method

#Declaration

TypeScript
getInsertedRowIndices(): number[]

#Returns

Type
number[]

#getRowVisibleIndices(includeDeleted) Method

#Declaration

TypeScript
getRowVisibleIndices(
    includeDeleted: boolean
): number[]

#Parameters

Name Type
includeDeleted boolean

#Returns

Type
number[]

#hasChanges Method

#Declaration

TypeScript
hasChanges(): boolean

#Returns

Type
boolean

#isDeletedRow(visibleIndex) Method

#Declaration

TypeScript
isDeletedRow(
    visibleIndex: number
): boolean

#Parameters

Name Type
visibleIndex number

#Returns

Type
boolean

#isNewRow(visibleIndex) Method

#Declaration

TypeScript
isNewRow(
    visibleIndex: number
): boolean

#Parameters

Name Type
visibleIndex number

#Returns

Type
boolean

#moveFocusBackward Method

#Declaration

TypeScript
moveFocusBackward(): boolean

#Returns

Type
boolean

#moveFocusForward Method

#Declaration

TypeScript
moveFocusForward(): boolean

#Returns

Type
boolean

#recoverRow(visibleIndex) Method

#Declaration

TypeScript
recoverRow(
    visibleIndex: number
): void

#Parameters

Name Type
visibleIndex number

#recoverRowByKey(key) Method

#Declaration

TypeScript
recoverRowByKey(
    key: any
): void

#Parameters

Name Type
key any

#resetChanges(visibleIndex) Method

#Declaration

TypeScript
resetChanges(
    visibleIndex: number
): void

#Parameters

Name Type
visibleIndex number

#resetChanges(visibleIndex, columnIndex) Method

#Declaration

TypeScript
resetChanges(
    visibleIndex: number,
    columnIndex: number
): void

#Parameters

Name Type
visibleIndex number
columnIndex number

#setCellValue(visibleIndex, columnFieldNameOrId, value) Method

#Declaration

TypeScript
setCellValue(
    visibleIndex: number,
    columnFieldNameOrId: string,
    value: any
): void

#Parameters

Name Type
visibleIndex number
columnFieldNameOrId string
value any

#setCellValue(visibleIndex, columnFieldNameOrId, value, displayText, cancelCellHighlighting) Method

#Declaration

TypeScript
setCellValue(
    visibleIndex: number,
    columnFieldNameOrId: string,
    value: any,
    displayText: string,
    cancelCellHighlighting: boolean
): void

#Parameters

Name Type
visibleIndex number
columnFieldNameOrId string
value any
displayText string
cancelCellHighlighting boolean

#startEdit(visibleIndex, columnIndex) Method

#Declaration

TypeScript
startEdit(
    visibleIndex: number,
    columnIndex: number
): void

#Parameters

Name Type
visibleIndex number
columnIndex number

#validateRow(visibleIndex) Method

#Declaration

TypeScript
validateRow(
    visibleIndex: number
): boolean

#Parameters

Name Type
visibleIndex number

#Returns

Type
boolean

#validateRows(validateOnlyModified) Method

#Declaration

TypeScript
validateRows(
    validateOnlyModified: boolean
): boolean

#Parameters

Name Type
validateOnlyModified boolean

#Returns

Type
boolean