BootstrapGridView Class

Declaration

export 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

BootstrapGridBase
BootstrapGridView

Properties

batchEditApi Property

Declaration

batchEditApi: BootstrapGridViewBatchEditApi | null

Property Value

Type Description
BootstrapGridViewBatchEditApi
null

Methods

addNewRow Method

Declaration

addNewRow(): void

applyFilter Method

Declaration

applyFilter(filterExpression: string): void

Parameters

Name Type Description
filterExpression

applyOnClickRowFilter Method

Declaration

applyOnClickRowFilter(): void

applySearchPanelFilter Method

Declaration

applySearchPanelFilter(value: string): void

Parameters

Name Type Description
value

autoFilterByColumn Method

Declaration

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

Parameters

Name Type Description
column
val

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 Method

Declaration

collapseDetailRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

collapseRow Method

Declaration

collapseRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

deleteRow Method

Declaration

deleteRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

deleteRowByKey Method

Declaration

deleteRowByKey(key: any): void

Parameters

Name Type Description
key

expandAll Method

Declaration

expandAll(): void

expandAllDetailRows Method

Declaration

expandAllDetailRows(): void

expandDetailRow Method

Declaration

expandDetailRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

expandRow Method

Declaration

expandRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

focus Method

Declaration

focus(): void

focusEditor Method

Declaration

focusEditor(column: BootstrapGridViewColumn): void

Parameters

Name Type Description
column

getAutoFilterEditor Method

Declaration

getAutoFilterEditor(column: BootstrapGridViewColumn): any

Parameters

Name Type Description
column

Returns

Type Description
any

getColumn Method

Declaration

getColumn(columnIndex: number): BootstrapGridViewColumn | null

Parameters

Name Type Description
columnIndex

Returns

Type Description
BootstrapGridViewColumn
null

getColumnByField Method

Declaration

getColumnByField(columnFieldName: string): BootstrapGridViewColumn | null

Parameters

Name Type Description
columnFieldName

Returns

Type Description
BootstrapGridViewColumn
null

getColumnById Method

Declaration

getColumnById(columnId: string): BootstrapGridViewColumn | null

Parameters

Name Type Description
columnId

Returns

Type Description
BootstrapGridViewColumn
null

getColumnCount Method

Declaration

getColumnCount(): number

Returns

Type Description
number

getColumnLayout Method

Declaration

getColumnLayout(): any

Returns

Type Description
any

getEditValue Method

Declaration

getEditValue(column: BootstrapGridViewColumn): string

Parameters

Name Type Description
column

Returns

Type Description
string

getEditor Method

Declaration

getEditor(column: BootstrapGridViewColumn): BootstrapClientEdit

Parameters

Name Type Description
column

Returns

Type Description
BootstrapClientEdit

getFocusedCell Method

Declaration

getFocusedCell(): BootstrapGridViewCellInfo | null

Returns

Type Description
BootstrapGridViewCellInfo
null

getFocusedRowIndex Method

Declaration

getFocusedRowIndex(): number

Returns

Type Description
number

getHorizontalScrollPosition Method

Declaration

getHorizontalScrollPosition(): number

Returns

Type Description
number

getPageCount Method

Declaration

getPageCount(): number

Returns

Type Description
number

getPageIndex Method

Declaration

getPageIndex(): number

Returns

Type Description
number

getPopupEditForm Method

Declaration

getPopupEditForm(): BootstrapPopupControl | null

Returns

Type Description
BootstrapPopupControl
null

getRowIndicesVisibleInViewPort Method

Declaration

getRowIndicesVisibleInViewPort(includePartiallyVisible: boolean): array[number]

Parameters

Name Type Description
includePartiallyVisible

Returns

Type Description
array[number]

getRowKey Method

Declaration

getRowKey(visibleIndex: number): string

Parameters

Name Type Description
visibleIndex

Returns

Type Description
string

getSelectedKeysOnPage Method

Declaration

getSelectedKeysOnPage(): array[any]

Returns

Type Description
array[any]

getSelectedRowCount Method

Declaration

getSelectedRowCount(): number

Returns

Type Description
number

getTopVisibleIndex Method

Declaration

getTopVisibleIndex(): number

Returns

Type Description
number

getVerticalScrollPosition Method

Declaration

getVerticalScrollPosition(): number

Returns

Type Description
number

getVisibleRowsOnPage Method

Declaration

getVisibleRowsOnPage(): number

Returns

Type Description
number

gotoPage Method

Declaration

gotoPage(pageIndex: number): void

Parameters

Name Type Description
pageIndex

groupBy Method

Declaration

groupBy(column: BootstrapGridViewColumn): void

Parameters

Name Type Description
column

hideCustomizationWindow Method

Declaration

hideCustomizationWindow(): void

isCustomizationWindowVisible Method

Declaration

isCustomizationWindowVisible(): boolean

Returns

Type Description
boolean

isDataRow Method

Declaration

isDataRow(visibleIndex: number): boolean

Parameters

Name Type Description
visibleIndex

Returns

Type Description
boolean

isEditing Method

Declaration

isEditing(): boolean

Returns

Type Description
boolean

isGroupRow Method

Declaration

isGroupRow(visibleIndex: number): boolean

Parameters

Name Type Description
visibleIndex

Returns

Type Description
boolean

isGroupRowExpanded Method

Declaration

isGroupRowExpanded(visibleIndex: number): boolean

Parameters

Name Type Description
visibleIndex

Returns

Type Description
boolean

isNewRowEditing Method

Declaration

isNewRowEditing(): boolean

Returns

Type Description
boolean

isRowSelectedOnPage Method

Declaration

isRowSelectedOnPage(visibleIndex: number): boolean

Parameters

Name Type Description
visibleIndex

Returns

Type Description
boolean

makeRowVisible Method

Declaration

makeRowVisible(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

nextPage Method

Declaration

nextPage(): void

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

performCallback Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Name Type Description
data

Returns

Type Description
Promise<void>

prevPage Method

Declaration

prevPage(): void

refresh Method

Declaration

refresh(): void

selectAllRowsOnPage Method

Declaration

selectAllRowsOnPage(): void

selectRowOnPage Method

Declaration

selectRowOnPage(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

selectRows Method

Declaration

selectRows(): void

selectRowsByKey Method

Declaration

selectRowsByKey(keys: array[any]): void

Parameters

Name Type Description
keys

setColumnLayout Method

Declaration

setColumnLayout(columnLayout: any): void

Parameters

Name Type Description
columnLayout

setEditValue Method

Declaration

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

Parameters

Name Type Description
column
value

setFilterEnabled Method

Declaration

setFilterEnabled(isFilterEnabled: boolean): void

Parameters

Name Type Description
isFilterEnabled

setFixedColumnScrollableRows Method

Declaration

setFixedColumnScrollableRows(scrollableRowSettings: any): void

Parameters

Name Type Description
scrollableRowSettings

setFocusedCell Method

Declaration

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

Parameters

Name Type Description
rowVisibleIndex
columnIndex

setFocusedRowIndex Method

Declaration

setFocusedRowIndex(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

setHorizontalScrollPosition Method

Declaration

setHorizontalScrollPosition(position: number): void

Parameters

Name Type Description
position

setSearchPanelCustomEditor Method

Declaration

setSearchPanelCustomEditor(editor: BootstrapClientEdit): void

Parameters

Name Type Description
editor

setVerticalScrollPosition Method

Declaration

setVerticalScrollPosition(position: number): void

Parameters

Name Type Description
position

showCustomizationDialog Method

Declaration

showCustomizationDialog(): void

showCustomizationWindow Method

Declaration

showCustomizationWindow(): void

showFilterControl Method

Declaration

showFilterControl(): void

sortBy Method

Declaration

sortBy(column: BootstrapGridViewColumn): void

Parameters

Name Type Description
column

startEditRow Method

Declaration

startEditRow(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

startEditRowByKey Method

Declaration

startEditRowByKey(key: any): void

Parameters

Name Type Description
key

ungroup Method

Declaration

ungroup(column: BootstrapGridViewColumn): void

Parameters

Name Type Description
column

unselectAllRowsOnPage Method

Declaration

unselectAllRowsOnPage(): void

unselectFilteredRows Method

Declaration

unselectFilteredRows(): void

unselectRowOnPage Method

Declaration

unselectRowOnPage(visibleIndex: number): void

Parameters

Name Type Description
visibleIndex

unselectRows Method

Declaration

unselectRows(): void

unselectRowsByKey Method

Declaration

unselectRowsByKey(keys: array[any]): void

Parameters

Name Type Description
keys

updateEdit Method

Declaration

updateEdit(): void