BootstrapGridView Class

Declaration

class BootstrapGridView extends BootstrapGridBase

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.

Inheritance

Control
BootstrapGridBase
BootstrapGridView

Properties

batchEditApi Property

Declaration

readonly batchEditApi: BootstrapGridViewBatchEditApi | null

Property Value

Type
BootstrapGridViewBatchEditApi
null

Methods

addNewRow Method

Declaration

addNewRow(): void

applyFilter(filterExpression) Method

Declaration

applyFilter(filterExpression: string): void

Parameters

Name Type
filterExpression string

applyOnClickRowFilter Method

Declaration

applyOnClickRowFilter(): void

applySearchPanelFilter(value) Method

Declaration

applySearchPanelFilter(value: string): void

Parameters

Name Type
value string

autoFilterByColumn(column, val) Method

Declaration

autoFilterByColumn(column: BootstrapGridViewColumn, val: string): void

Parameters

Name Type
column BootstrapGridViewColumn
val string

autoFilterByColumn(columnFieldNameOrId, val) Method

Declaration

autoFilterByColumn(columnFieldNameOrId: string, val: string): void

Parameters

Name Type
columnFieldNameOrId string
val string

autoFilterByColumn(columnIndex, val) Method

Declaration

autoFilterByColumn(columnIndex: number, val: string): void

Parameters

Name Type
columnIndex number
val string

cancelEdit Method

Declaration

cancelEdit(): void

clearFilter Method

Declaration

clearFilter(): void

closeFilterControl Method

Declaration

closeFilterControl(): void

collapseAll Method

Declaration

collapseAll(): void

collapseAllDetailRows Method

Declaration

collapseAllDetailRows(): void

collapseDetailRow(visibleIndex) Method

Declaration

collapseDetailRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

collapseRow(visibleIndex) Method

Declaration

collapseRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

collapseRow(visibleIndex, recursive) Method

Declaration

collapseRow(visibleIndex: number, recursive: boolean): void

Parameters

Name Type
visibleIndex number
recursive boolean

deleteRow(visibleIndex) Method

Declaration

deleteRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

deleteRowByKey(key) Method

Declaration

deleteRowByKey(key: any): void

Parameters

Name Type
key any

expandAll Method

Declaration

expandAll(): void

expandAllDetailRows Method

Declaration

expandAllDetailRows(): void

expandDetailRow(visibleIndex) Method

Declaration

expandDetailRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

expandRow(visibleIndex) Method

Declaration

expandRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

expandRow(visibleIndex, recursive) Method

Declaration

expandRow(visibleIndex: number, recursive: boolean): void

Parameters

Name Type
visibleIndex number
recursive boolean

focus Method

Declaration

focus(): void

focusEditor(column) Method

Declaration

focusEditor(column: BootstrapGridViewColumn): void

Parameters

Name Type
column BootstrapGridViewColumn

focusEditor(columnFieldNameOrId) Method

Declaration

focusEditor(columnFieldNameOrId: string): void

Parameters

Name Type
columnFieldNameOrId string

focusEditor(columnIndex) Method

Declaration

focusEditor(columnIndex: number): void

Parameters

Name Type
columnIndex number

getAutoFilterEditor(column) Method

Declaration

getAutoFilterEditor(column: BootstrapGridViewColumn): any

Parameters

Name Type
column BootstrapGridViewColumn

Returns

Type
any

getAutoFilterEditor(columnFieldNameOrId) Method

Declaration

getAutoFilterEditor(columnFieldNameOrId: string): any

Parameters

Name Type
columnFieldNameOrId string

Returns

Type
any

getAutoFilterEditor(columnIndex) Method

Declaration

getAutoFilterEditor(columnIndex: number): any

Parameters

Name Type
columnIndex number

Returns

Type
any

getColumn(columnIndex) Method

Declaration

getColumn(columnIndex: number): BootstrapGridViewColumn | null

Parameters

Name Type
columnIndex number

Returns

Type
BootstrapGridViewColumn
null

getColumnByField(columnFieldName) Method

Declaration

getColumnByField(columnFieldName: string): BootstrapGridViewColumn | null

Parameters

Name Type
columnFieldName string

Returns

Type
BootstrapGridViewColumn
null

getColumnById(columnId) Method

Declaration

getColumnById(columnId: string): BootstrapGridViewColumn | null

Parameters

Name Type
columnId string

Returns

Type
BootstrapGridViewColumn
null

getColumnCount Method

Declaration

getColumnCount(): number

Returns

Type
number

getColumnLayout Method

Declaration

getColumnLayout(): any

Returns

Type
any

getEditor(column) Method

Declaration

getEditor(column: BootstrapGridViewColumn): BootstrapClientEdit

Parameters

Name Type
column BootstrapGridViewColumn

Returns

Type
BootstrapClientEdit

getEditor(columnFieldNameOrId) Method

Declaration

getEditor(columnFieldNameOrId: string): BootstrapClientEdit

Parameters

Name Type
columnFieldNameOrId string

Returns

Type
BootstrapClientEdit

getEditor(columnIndex) Method

Declaration

getEditor(columnIndex: number): BootstrapClientEdit

Parameters

Name Type
columnIndex number

Returns

Type
BootstrapClientEdit

getEditValue(column) Method

Declaration

getEditValue(column: BootstrapGridViewColumn): string

Parameters

Name Type
column BootstrapGridViewColumn

Returns

Type
string

getEditValue(columnFieldNameOrId) Method

Declaration

getEditValue(columnFieldNameOrId: string): string

Parameters

Name Type
columnFieldNameOrId string

Returns

Type
string

getEditValue(columnIndex) Method

Declaration

getEditValue(columnIndex: number): string

Parameters

Name Type
columnIndex number

Returns

Type
string

getFocusedCell Method

Declaration

getFocusedCell(): BootstrapGridViewCellInfo | null

Returns

Type
BootstrapGridViewCellInfo
null

getFocusedRowIndex Method

Declaration

getFocusedRowIndex(): number

Returns

Type
number

getHorizontalScrollPosition Method

Declaration

getHorizontalScrollPosition(): number

Returns

Type
number

getPageCount Method

Declaration

getPageCount(): number

Returns

Type
number

getPageIndex Method

Declaration

getPageIndex(): number

Returns

Type
number

getPopupEditForm Method

Declaration

getPopupEditForm(): BootstrapPopupControl | null

Returns

Type
BootstrapPopupControl
null

getRowIndicesVisibleInViewPort(includePartiallyVisible) Method

Declaration

getRowIndicesVisibleInViewPort(includePartiallyVisible: boolean): number[]

Parameters

Name Type
includePartiallyVisible boolean

Returns

Type
number[]

getRowKey(visibleIndex) Method

Declaration

getRowKey(visibleIndex: number): string

Parameters

Name Type
visibleIndex number

Returns

Type
string

getSelectedKeysOnPage Method

Declaration

getSelectedKeysOnPage(): any[]

Returns

Type
any[]

getSelectedRowCount Method

Declaration

getSelectedRowCount(): number

Returns

Type
number

getTopVisibleIndex Method

Declaration

getTopVisibleIndex(): number

Returns

Type
number

getVerticalScrollPosition Method

Declaration

getVerticalScrollPosition(): number

Returns

Type
number

getVisibleRowsOnPage Method

Declaration

getVisibleRowsOnPage(): number

Returns

Type
number

gotoPage(pageIndex) Method

Declaration

gotoPage(pageIndex: number): void

Parameters

Name Type
pageIndex number

groupBy(column) Method

Declaration

groupBy(column: BootstrapGridViewColumn): void

Parameters

Name Type
column BootstrapGridViewColumn

groupBy(column, groupIndex) Method

Declaration

groupBy(column: BootstrapGridViewColumn, groupIndex: number): void

Parameters

Name Type
column BootstrapGridViewColumn
groupIndex number

groupBy(column, groupIndex, sortOrder) Method

Declaration

groupBy(column: BootstrapGridViewColumn, groupIndex: number, sortOrder: string): void

Parameters

Name Type
column BootstrapGridViewColumn
groupIndex number
sortOrder string

groupBy(columnFieldNameOrId) Method

Declaration

groupBy(columnFieldNameOrId: string): void

Parameters

Name Type
columnFieldNameOrId string

groupBy(columnFieldNameOrId, groupIndex) Method

Declaration

groupBy(columnFieldNameOrId: string, groupIndex: number): void

Parameters

Name Type
columnFieldNameOrId string
groupIndex number

groupBy(columnFieldNameOrId, groupIndex, sortOrder) Method

Declaration

groupBy(columnFieldNameOrId: string, groupIndex: number, sortOrder: string): void

Parameters

Name Type
columnFieldNameOrId string
groupIndex number
sortOrder string

groupBy(columnIndex) Method

Declaration

groupBy(columnIndex: number): void

Parameters

Name Type
columnIndex number

groupBy(columnIndex, groupIndex) Method

Declaration

groupBy(columnIndex: number, groupIndex: number): void

Parameters

Name Type
columnIndex number
groupIndex number

groupBy(columnIndex, groupIndex, sortOrder) Method

Declaration

groupBy(columnIndex: number, groupIndex: number, sortOrder: string): void

Parameters

Name Type
columnIndex number
groupIndex number
sortOrder string

hideCustomizationWindow Method

Declaration

hideCustomizationWindow(): void

isCustomizationWindowVisible Method

Declaration

isCustomizationWindowVisible(): boolean

Returns

Type
boolean

isDataRow(visibleIndex) Method

Declaration

isDataRow(visibleIndex: number): boolean

Parameters

Name Type
visibleIndex number

Returns

Type
boolean

isEditing Method

Declaration

isEditing(): boolean

Returns

Type
boolean

isGroupRow(visibleIndex) Method

Declaration

isGroupRow(visibleIndex: number): boolean

Parameters

Name Type
visibleIndex number

Returns

Type
boolean

isGroupRowExpanded(visibleIndex) Method

Declaration

isGroupRowExpanded(visibleIndex: number): boolean

Parameters

Name Type
visibleIndex number

Returns

Type
boolean

isNewRowEditing Method

Declaration

isNewRowEditing(): boolean

Returns

Type
boolean

isRowSelectedOnPage(visibleIndex) Method

Declaration

isRowSelectedOnPage(visibleIndex: number): boolean

Parameters

Name Type
visibleIndex number

Returns

Type
boolean

makeRowVisible(visibleIndex) Method

Declaration

makeRowVisible(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

nextPage Method

Declaration

nextPage(): void

off<K> Method

Declaration

off<K extends keyof BootstrapGridViewEventMap>(eventName?: K, callback?: (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

on<K extends keyof BootstrapGridViewEventMap>(eventName: K, callback: (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

once<K extends keyof BootstrapGridViewEventMap>(eventName: K, callback: (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapGridView, args?: BootstrapGridViewEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

performCallback(data) Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Name Type
data any

Returns

Type
Promise<void>

performCallback(data, onSuccess) Method

Declaration

performCallback(data: any, onSuccess: () => void): void

Parameters

Name Type
data any
onSuccess () => void

prevPage Method

Declaration

prevPage(): void

refresh Method

Declaration

refresh(): void

selectAllRowsOnPage Method

Declaration

selectAllRowsOnPage(): void

selectRowOnPage(visibleIndex) Method

Declaration

selectRowOnPage(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

selectRowOnPage(visibleIndex, selected) Method

Declaration

selectRowOnPage(visibleIndex: number, selected: boolean): void

Parameters

Name Type
visibleIndex number
selected boolean

selectRows Method

Declaration

selectRows(): void

selectRowsByKey(key) Method

Declaration

selectRowsByKey(key: any): void

Parameters

Name Type
key any

selectRowsByKey(key, selected) Method

Declaration

selectRowsByKey(key: any, selected: boolean): void

Parameters

Name Type
key any
selected boolean

selectRowsByKey(keys) Method

Declaration

selectRowsByKey(keys: any[]): void

Parameters

Name Type
keys any[]

selectRowsByKey(keys, selected) Method

Declaration

selectRowsByKey(keys: any[], selected: boolean): void

Parameters

Name Type
keys any[]
selected boolean

setColumnLayout(columnLayout) Method

Declaration

setColumnLayout(columnLayout: any): void

Parameters

Name Type
columnLayout any

setEditValue(column, value) Method

Declaration

setEditValue(column: BootstrapGridViewColumn, value: string): void

Parameters

Name Type
column BootstrapGridViewColumn
value string

setEditValue(columnFieldNameOrId, value) Method

Declaration

setEditValue(columnFieldNameOrId: string, value: string): void

Parameters

Name Type
columnFieldNameOrId string
value string

setEditValue(columnIndex, value) Method

Declaration

setEditValue(columnIndex: number, value: string): void

Parameters

Name Type
columnIndex number
value string

setFilterEnabled(isFilterEnabled) Method

Declaration

setFilterEnabled(isFilterEnabled: boolean): void

Parameters

Name Type
isFilterEnabled boolean

setFixedColumnScrollableRows(scrollableRowSettings) Method

Declaration

setFixedColumnScrollableRows(scrollableRowSettings: any): void

Parameters

Name Type
scrollableRowSettings any

setFocusedCell(rowVisibleIndex, columnIndex) Method

Declaration

setFocusedCell(rowVisibleIndex: number, columnIndex: number): void

Parameters

Name Type
rowVisibleIndex number
columnIndex number

setFocusedRowIndex(visibleIndex) Method

Declaration

setFocusedRowIndex(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

setHorizontalScrollPosition(position) Method

Declaration

setHorizontalScrollPosition(position: number): void

Parameters

Name Type
position number

setSearchPanelCustomEditor(editor) Method

Declaration

setSearchPanelCustomEditor(editor: BootstrapClientEdit): void

Parameters

Name Type
editor BootstrapClientEdit

setVerticalScrollPosition(position) Method

Declaration

setVerticalScrollPosition(position: number): void

Parameters

Name Type
position number

showCustomizationDialog Method

Declaration

showCustomizationDialog(): void

showCustomizationWindow Method

Declaration

showCustomizationWindow(): void

showFilterControl Method

Declaration

showFilterControl(): void

sortBy(column) Method

Declaration

sortBy(column: BootstrapGridViewColumn): void

Parameters

Name Type
column BootstrapGridViewColumn

sortBy(column, sortOrder) Method

Declaration

sortBy(column: BootstrapGridViewColumn, sortOrder: string): void

Parameters

Name Type
column BootstrapGridViewColumn
sortOrder string

sortBy(column, sortOrder, reset) Method

Declaration

sortBy(column: BootstrapGridViewColumn, sortOrder: string, reset: boolean): void

Parameters

Name Type
column BootstrapGridViewColumn
sortOrder string
reset boolean

sortBy(column, sortOrder, reset, sortIndex) Method

Declaration

sortBy(column: BootstrapGridViewColumn, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Name Type
column BootstrapGridViewColumn
sortOrder string
reset boolean
sortIndex number

sortBy(columnFieldNameOrId) Method

Declaration

sortBy(columnFieldNameOrId: string): void

Parameters

Name Type
columnFieldNameOrId string

sortBy(columnFieldNameOrId, sortOrder) Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string): void

Parameters

Name Type
columnFieldNameOrId string
sortOrder string

sortBy(columnFieldNameOrId, sortOrder, reset) Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string, reset: boolean): void

Parameters

Name Type
columnFieldNameOrId string
sortOrder string
reset boolean

sortBy(columnFieldNameOrId, sortOrder, reset, sortIndex) Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Name Type
columnFieldNameOrId string
sortOrder string
reset boolean
sortIndex number

sortBy(columnIndex) Method

Declaration

sortBy(columnIndex: number): void

Parameters

Name Type
columnIndex number

sortBy(columnIndex, sortOrder) Method

Declaration

sortBy(columnIndex: number, sortOrder: string): void

Parameters

Name Type
columnIndex number
sortOrder string

sortBy(columnIndex, sortOrder, reset) Method

Declaration

sortBy(columnIndex: number, sortOrder: string, reset: boolean): void

Parameters

Name Type
columnIndex number
sortOrder string
reset boolean

sortBy(columnIndex, sortOrder, reset, sortIndex) Method

Declaration

sortBy(columnIndex: number, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Name Type
columnIndex number
sortOrder string
reset boolean
sortIndex number

startEditRow(visibleIndex) Method

Declaration

startEditRow(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

startEditRowByKey(key) Method

Declaration

startEditRowByKey(key: any): void

Parameters

Name Type
key any

ungroup(column) Method

Declaration

ungroup(column: BootstrapGridViewColumn): void

Parameters

Name Type
column BootstrapGridViewColumn

ungroup(columnFieldNameOrId) Method

Declaration

ungroup(columnFieldNameOrId: string): void

Parameters

Name Type
columnFieldNameOrId string

ungroup(columnIndex) Method

Declaration

ungroup(columnIndex: number): void

Parameters

Name Type
columnIndex number

unselectAllRowsOnPage Method

Declaration

unselectAllRowsOnPage(): void

unselectFilteredRows Method

Declaration

unselectFilteredRows(): void

unselectRowOnPage(visibleIndex) Method

Declaration

unselectRowOnPage(visibleIndex: number): void

Parameters

Name Type
visibleIndex number

unselectRows Method

Declaration

unselectRows(): void

unselectRowsByKey(key) Method

Declaration

unselectRowsByKey(key: any): void

Parameters

Name Type
key any

unselectRowsByKey(keys) Method

Declaration

unselectRowsByKey(keys: any[]): void

Parameters

Name Type
keys any[]

updateEdit Method

Declaration

updateEdit(): void