BootstrapGridView Class

Declaration

export class BootstrapGridView extends BootstrapGridBase

Inheritance

BootstrapGridBase
BootstrapGridView

Properties

batchEditApi Property

Declaration

batchEditApi: BootstrapGridViewBatchEditApi | null

Property Value

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_batchEditApi
js_DevExpress_AspNetCore_BootstrapGridView_batchEditApi

Methods

addNewRow Method

Declaration

addNewRow(): void

applyFilter Method

Declaration

applyFilter(filterExpression: string): void

Parameters

Type Name Description
filterExpression

applyOnClickRowFilter Method

Declaration

applyOnClickRowFilter(): void

applySearchPanelFilter Method

Declaration

applySearchPanelFilter(value: string): void

Parameters

Type Name Description
value

autoFilterByColumn Method

Declaration

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

Parameters

Type Name 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

Type Name Description
visibleIndex

collapseRow Method

Declaration

collapseRow(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

deleteRow Method

Declaration

deleteRow(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

deleteRowByKey Method

Declaration

deleteRowByKey(key: any): void

Parameters

Type Name Description
key

expandAll Method

Declaration

expandAll(): void

expandAllDetailRows Method

Declaration

expandAllDetailRows(): void

expandDetailRow Method

Declaration

expandDetailRow(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

expandRow Method

Declaration

expandRow(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

focus Method

Declaration

focus(): void

focusEditor Method

Declaration

focusEditor(column: BootstrapGridViewColumn): void

Parameters

Type Name Description
column

getAutoFilterEditor Method

Declaration

getAutoFilterEditor(column: BootstrapGridViewColumn): any

Parameters

Type Name Description
column

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getAutoFilterEditor

getColumn Method

Declaration

getColumn(columnIndex: number): BootstrapGridViewColumn | null

Parameters

Type Name Description
columnIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getColumn
js_DevExpress_AspNetCore_BootstrapGridView_getColumn

getColumnByField Method

Declaration

getColumnByField(columnFieldName: string): BootstrapGridViewColumn | null

Parameters

Type Name Description
columnFieldName

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getColumnByField
js_DevExpress_AspNetCore_BootstrapGridView_getColumnByField

getColumnById Method

Declaration

getColumnById(columnId: string): BootstrapGridViewColumn | null

Parameters

Type Name Description
columnId

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getColumnById
js_DevExpress_AspNetCore_BootstrapGridView_getColumnById

getColumnCount Method

Declaration

getColumnCount(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getColumnCount

getColumnLayout Method

Declaration

getColumnLayout(): any

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getColumnLayout

getEditValue Method

Declaration

getEditValue(column: BootstrapGridViewColumn): string

Parameters

Type Name Description
column

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getEditValue

getEditor Method

Declaration

getEditor(column: BootstrapGridViewColumn): BootstrapClientEdit

Parameters

Type Name Description
column

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getEditor

getFocusedCell Method

Declaration

getFocusedCell(): BootstrapGridViewCellInfo | null

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getFocusedCell
js_DevExpress_AspNetCore_BootstrapGridView_getFocusedCell

getFocusedRowIndex Method

Declaration

getFocusedRowIndex(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getFocusedRowIndex

getHorizontalScrollPosition Method

Declaration

getHorizontalScrollPosition(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getHorizontalScrollPosition

getPageCount Method

Declaration

getPageCount(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getPageCount

getPageIndex Method

Declaration

getPageIndex(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getPageIndex

getPopupEditForm Method

Declaration

getPopupEditForm(): BootstrapPopupControl | null

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getPopupEditForm
js_DevExpress_AspNetCore_BootstrapGridView_getPopupEditForm

getRowIndicesVisibleInViewPort Method

Declaration

getRowIndicesVisibleInViewPort(includePartiallyVisible: boolean): array[number]

Parameters

Type Name Description
includePartiallyVisible

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getRowIndicesVisibleInViewPort

getRowKey Method

Declaration

getRowKey(visibleIndex: number): string

Parameters

Type Name Description
visibleIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getRowKey

getSelectedKeysOnPage Method

Declaration

getSelectedKeysOnPage(): array[any]

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getSelectedKeysOnPage

getSelectedRowCount Method

Declaration

getSelectedRowCount(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getSelectedRowCount

getTopVisibleIndex Method

Declaration

getTopVisibleIndex(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getTopVisibleIndex

getVerticalScrollPosition Method

Declaration

getVerticalScrollPosition(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getVerticalScrollPosition

getVisibleRowsOnPage Method

Declaration

getVisibleRowsOnPage(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_getVisibleRowsOnPage

gotoPage Method

Declaration

gotoPage(pageIndex: number): void

Parameters

Type Name Description
pageIndex

groupBy Method

Declaration

groupBy(column: BootstrapGridViewColumn): void

Parameters

Type Name Description
column

hideCustomizationWindow Method

Declaration

hideCustomizationWindow(): void

isCustomizationWindowVisible Method

Declaration

isCustomizationWindowVisible(): boolean

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isCustomizationWindowVisible

isDataRow Method

Declaration

isDataRow(visibleIndex: number): boolean

Parameters

Type Name Description
visibleIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isDataRow

isEditing Method

Declaration

isEditing(): boolean

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isEditing

isGroupRow Method

Declaration

isGroupRow(visibleIndex: number): boolean

Parameters

Type Name Description
visibleIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isGroupRow

isGroupRowExpanded Method

Declaration

isGroupRowExpanded(visibleIndex: number): boolean

Parameters

Type Name Description
visibleIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isGroupRowExpanded

isNewRowEditing Method

Declaration

isNewRowEditing(): boolean

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isNewRowEditing

isRowSelectedOnPage Method

Declaration

isRowSelectedOnPage(visibleIndex: number): boolean

Parameters

Type Name Description
visibleIndex

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_isRowSelectedOnPage

makeRowVisible Method

Declaration

makeRowVisible(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

nextPage Method

Declaration

nextPage(): void

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_off

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_on

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_once

performCallback Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Type Name Description
data

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapGridView_performCallback

prevPage Method

Declaration

prevPage(): void

refresh Method

Declaration

refresh(): void

selectAllRowsOnPage Method

Declaration

selectAllRowsOnPage(): void

selectRowOnPage Method

Declaration

selectRowOnPage(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

selectRows Method

Declaration

selectRows(): void

selectRowsByKey Method

Declaration

selectRowsByKey(keys: array[any]): void

Parameters

Type Name Description
keys

setColumnLayout Method

Declaration

setColumnLayout(columnLayout: any): void

Parameters

Type Name Description
columnLayout

setEditValue Method

Declaration

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

Parameters

Type Name Description
column
value

setFilterEnabled Method

Declaration

setFilterEnabled(isFilterEnabled: boolean): void

Parameters

Type Name Description
isFilterEnabled

setFixedColumnScrollableRows Method

Declaration

setFixedColumnScrollableRows(scrollableRowSettings: any): void

Parameters

Type Name Description
scrollableRowSettings

setFocusedCell Method

Declaration

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

Parameters

Type Name Description
rowVisibleIndex
columnIndex

setFocusedRowIndex Method

Declaration

setFocusedRowIndex(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

setHorizontalScrollPosition Method

Declaration

setHorizontalScrollPosition(position: number): void

Parameters

Type Name Description
position

setSearchPanelCustomEditor Method

Declaration

setSearchPanelCustomEditor(editor: BootstrapClientEdit): void

Parameters

Type Name Description
editor

setVerticalScrollPosition Method

Declaration

setVerticalScrollPosition(position: number): void

Parameters

Type Name 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

Type Name Description
column

startEditRow Method

Declaration

startEditRow(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

startEditRowByKey Method

Declaration

startEditRowByKey(key: any): void

Parameters

Type Name Description
key

ungroup Method

Declaration

ungroup(column: BootstrapGridViewColumn): void

Parameters

Type Name Description
column

unselectAllRowsOnPage Method

Declaration

unselectAllRowsOnPage(): void

unselectFilteredRows Method

Declaration

unselectFilteredRows(): void

unselectRowOnPage Method

Declaration

unselectRowOnPage(visibleIndex: number): void

Parameters

Type Name Description
visibleIndex

unselectRows Method

Declaration

unselectRows(): void

unselectRowsByKey Method

Declaration

unselectRowsByKey(keys: array[any]): void

Parameters

Type Name Description
keys

updateEdit Method

Declaration

updateEdit(): void