BootstrapGridView Class
In This Article
#Declaration
TypeScript
class BootstrapGridView extends BootstrapGridBase
#Remarks
IMPORTANT
Bootstrap Controls for ASP.
#Inherited Members
#Inheritance
Control
BootstrapGridBase
BootstrapGridView
#Properties
#batchEditApi Property
#Declaration
TypeScript
readonly batchEditApi: BootstrapGridViewBatchEditApi | null
#Property Value
Type |
---|
Bootstrap |
null |
#Methods
#addNewRow Method
#Declaration
TypeScript
addNewRow(): void
#applyFilter(filterExpression) Method
#Declaration
TypeScript
applyFilter(
filterExpression: string
): void
#Parameters
Name | Type |
---|---|
filter |
string |
#applyOnClickRowFilter Method
#Declaration
TypeScript
applyOnClickRowFilter(): void
#applySearchPanelFilter(value) Method
#Declaration
TypeScript
applySearchPanelFilter(
value: string
): void
#Parameters
Name | Type |
---|---|
value | string |
#autoFilterByColumn(column, val) Method
#Declaration
TypeScript
autoFilterByColumn(
column: BootstrapGridViewColumn,
val: string
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
val | string |
#autoFilterByColumn(columnFieldNameOrId, val) Method
#Declaration
TypeScript
autoFilterByColumn(
columnFieldNameOrId: string,
val: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
val | string |
#autoFilterByColumn(columnIndex, val) Method
#Declaration
TypeScript
autoFilterByColumn(
columnIndex: number,
val: string
): void
#Parameters
Name | Type |
---|---|
column |
number |
val | string |
#cancelEdit Method
#Declaration
TypeScript
cancelEdit(): void
#clearFilter Method
#Declaration
TypeScript
clearFilter(): void
#closeFilterControl Method
#Declaration
TypeScript
closeFilterControl(): void
#collapseAll Method
#Declaration
TypeScript
collapseAll(): void
#collapseAllDetailRows Method
#Declaration
TypeScript
collapseAllDetailRows(): void
#collapseDetailRow(visibleIndex) Method
#Declaration
TypeScript
collapseDetailRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#collapseRow(visibleIndex) Method
#Declaration
TypeScript
collapseRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#collapseRow(visibleIndex, recursive) Method
#Declaration
TypeScript
collapseRow(
visibleIndex: number,
recursive: boolean
): void
#Parameters
Name | Type |
---|---|
visible |
number |
recursive | boolean |
#deleteRow(visibleIndex) Method
#Declaration
TypeScript
deleteRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#deleteRowByKey(key) Method
#Declaration
TypeScript
deleteRowByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#expandAll Method
#Declaration
TypeScript
expandAll(): void
#expandAllDetailRows Method
#Declaration
TypeScript
expandAllDetailRows(): void
#expandDetailRow(visibleIndex) Method
#Declaration
TypeScript
expandDetailRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#expandRow(visibleIndex) Method
#Declaration
TypeScript
expandRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#expandRow(visibleIndex, recursive) Method
#Declaration
TypeScript
expandRow(
visibleIndex: number,
recursive: boolean
): void
#Parameters
Name | Type |
---|---|
visible |
number |
recursive | boolean |
#focus Method
#Declaration
TypeScript
focus(): void
#focusEditor(column) Method
#Declaration
TypeScript
focusEditor(
column: BootstrapGridViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#focusEditor(columnFieldNameOrId) Method
#Declaration
TypeScript
focusEditor(
columnFieldNameOrId: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
#focusEditor(columnIndex) Method
#Declaration
TypeScript
focusEditor(
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
#getAutoFilterEditor(column) Method
#Declaration
TypeScript
getAutoFilterEditor(
column: BootstrapGridViewColumn
): any
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#Returns
Type |
---|
any |
#getAutoFilterEditor(columnFieldNameOrId) Method
#Declaration
TypeScript
getAutoFilterEditor(
columnFieldNameOrId: string
): any
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
any |
#getAutoFilterEditor(columnIndex) Method
#Declaration
TypeScript
getAutoFilterEditor(
columnIndex: number
): any
#Parameters
Name | Type |
---|---|
column |
number |
#Returns
Type |
---|
any |
#getColumn(columnIndex) Method
#Declaration
TypeScript
getColumn(
columnIndex: number
): BootstrapGridViewColumn | null
#Parameters
Name | Type |
---|---|
column |
number |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnByField(columnFieldName) Method
#Declaration
TypeScript
getColumnByField(
columnFieldName: string
): BootstrapGridViewColumn | null
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnById(columnId) Method
#Declaration
TypeScript
getColumnById(
columnId: string
): BootstrapGridViewColumn | null
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnCount Method
#Declaration
TypeScript
getColumnCount(): number
#Returns
Type |
---|
number |
#getColumnLayout Method
#Declaration
TypeScript
getColumnLayout(): any
#Returns
Type |
---|
any |
#getEditor(column) Method
#Declaration
TypeScript
getEditor(
column: BootstrapGridViewColumn
): BootstrapClientEdit
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#Returns
Type |
---|
Bootstrap |
#getEditor(columnFieldNameOrId) Method
#Declaration
TypeScript
getEditor(
columnFieldNameOrId: string
): BootstrapClientEdit
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
Bootstrap |
#getEditor(columnIndex) Method
#Declaration
TypeScript
getEditor(
columnIndex: number
): BootstrapClientEdit
#Parameters
Name | Type |
---|---|
column |
number |
#Returns
Type |
---|
Bootstrap |
#getEditValue(column) Method
#Declaration
TypeScript
getEditValue(
column: BootstrapGridViewColumn
): string
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#Returns
Type |
---|
string |
#getEditValue(columnFieldNameOrId) Method
#Declaration
TypeScript
getEditValue(
columnFieldNameOrId: string
): string
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
string |
#getEditValue(columnIndex) Method
#Declaration
TypeScript
getEditValue(
columnIndex: number
): string
#Parameters
Name | Type |
---|---|
column |
number |
#Returns
Type |
---|
string |
#getFocusedCell Method
#Declaration
TypeScript
getFocusedCell(): BootstrapGridViewCellInfo | null
#Returns
Type |
---|
Bootstrap |
null |
#getFocusedRowIndex Method
#Declaration
TypeScript
getFocusedRowIndex(): number
#Returns
Type |
---|
number |
#getHorizontalScrollPosition Method
#Declaration
TypeScript
getHorizontalScrollPosition(): number
#Returns
Type |
---|
number |
#getPageCount Method
#Declaration
TypeScript
getPageCount(): number
#Returns
Type |
---|
number |
#getPageIndex Method
#Declaration
TypeScript
getPageIndex(): number
#Returns
Type |
---|
number |
#getPopupEditForm Method
#Declaration
TypeScript
getPopupEditForm(): BootstrapPopupControl | null
#Returns
Type |
---|
Bootstrap |
null |
#getRowIndicesVisibleInViewPort(includePartiallyVisible) Method
#Declaration
TypeScript
getRowIndicesVisibleInViewPort(
includePartiallyVisible: boolean
): number[]
#Parameters
Name | Type |
---|---|
include |
boolean |
#Returns
Type |
---|
number[] |
#getRowKey(visibleIndex) Method
#Declaration
TypeScript
getRowKey(
visibleIndex: number
): string
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
string |
#getSelectedKeysOnPage Method
#Declaration
TypeScript
getSelectedKeysOnPage(): any[]
#Returns
Type |
---|
any[] |
#getSelectedRowCount Method
#Declaration
TypeScript
getSelectedRowCount(): number
#Returns
Type |
---|
number |
#getTopVisibleIndex Method
#Declaration
TypeScript
getTopVisibleIndex(): number
#Returns
Type |
---|
number |
#getVerticalScrollPosition Method
#Declaration
TypeScript
getVerticalScrollPosition(): number
#Returns
Type |
---|
number |
#getVisibleRowsOnPage Method
#Declaration
TypeScript
getVisibleRowsOnPage(): number
#Returns
Type |
---|
number |
#gotoPage(pageIndex) Method
#Declaration
TypeScript
gotoPage(
pageIndex: number
): void
#Parameters
Name | Type |
---|---|
page |
number |
#groupBy(column) Method
#Declaration
TypeScript
groupBy(
column: BootstrapGridViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#groupBy(column, groupIndex) Method
#Declaration
TypeScript
groupBy(
column: BootstrapGridViewColumn,
groupIndex: number
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
group |
number |
#groupBy(column, groupIndex, sortOrder) Method
#Declaration
TypeScript
groupBy(
column: BootstrapGridViewColumn,
groupIndex: number,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
group |
number |
sort |
string |
#groupBy(columnFieldNameOrId) Method
#Declaration
TypeScript
groupBy(
columnFieldNameOrId: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
#groupBy(columnFieldNameOrId, groupIndex) Method
#Declaration
TypeScript
groupBy(
columnFieldNameOrId: string,
groupIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
string |
group |
number |
#groupBy(columnFieldNameOrId, groupIndex, sortOrder) Method
#Declaration
TypeScript
groupBy(
columnFieldNameOrId: string,
groupIndex: number,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
group |
number |
sort |
string |
#groupBy(columnIndex) Method
#Declaration
TypeScript
groupBy(
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
#groupBy(columnIndex, groupIndex) Method
#Declaration
TypeScript
groupBy(
columnIndex: number,
groupIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
group |
number |
#groupBy(columnIndex, groupIndex, sortOrder) Method
#Declaration
TypeScript
groupBy(
columnIndex: number,
groupIndex: number,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column |
number |
group |
number |
sort |
string |
#hideCustomizationWindow Method
#Declaration
TypeScript
hideCustomizationWindow(): void
#isCustomizationWindowVisible Method
#Declaration
TypeScript
isCustomizationWindowVisible(): boolean
#Returns
Type |
---|
boolean |
#isDataRow(visibleIndex) Method
#Declaration
TypeScript
isDataRow(
visibleIndex: number
): boolean
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
boolean |
#isEditing Method
#Declaration
TypeScript
isEditing(): boolean
#Returns
Type |
---|
boolean |
#isGroupRow(visibleIndex) Method
#Declaration
TypeScript
isGroupRow(
visibleIndex: number
): boolean
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
boolean |
#isGroupRowExpanded(visibleIndex) Method
#Declaration
TypeScript
isGroupRowExpanded(
visibleIndex: number
): boolean
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
boolean |
#isNewRowEditing Method
#Declaration
TypeScript
isNewRowEditing(): boolean
#Returns
Type |
---|
boolean |
#isRowSelectedOnPage(visibleIndex) Method
#Declaration
TypeScript
isRowSelectedOnPage(
visibleIndex: number
): boolean
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
boolean |
#makeRowVisible(visibleIndex) Method
#Declaration
TypeScript
makeRowVisible(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#nextPage Method
#Declaration
TypeScript
nextPage(): void
#off<K> Method
#Declaration
TypeScript
off<K extends keyof BootstrapGridViewEventMap>(
eventName?: K,
callback?: (this: BootstrapGridView,
args?: BootstrapGridViewEventMap[K]) => void
): this
#Parameters
Name | Type |
---|---|
event |
K |
callback | (this: Bootstrap |
#Type Parameters
Name | Type |
---|---|
K | keyof |
#Returns
Type |
---|
this |
#on<K>(eventName, callback) Method
#Declaration
TypeScript
on<K extends keyof BootstrapGridViewEventMap>(
eventName: K,
callback: (this: BootstrapGridView,
args?: BootstrapGridViewEventMap[K]) => void
): this
#Parameters
Name | Type |
---|---|
event |
K |
callback | (this: Bootstrap |
#Type Parameters
Name | Type |
---|---|
K | keyof |
#Returns
Type |
---|
this |
#once<K>(eventName, callback) Method
#Declaration
TypeScript
once<K extends keyof BootstrapGridViewEventMap>(
eventName: K,
callback: (this: BootstrapGridView,
args?: BootstrapGridViewEventMap[K]) => void
): this
#Parameters
Name | Type |
---|---|
event |
K |
callback | (this: Bootstrap |
#Type Parameters
Name | Type |
---|---|
K | keyof |
#Returns
Type |
---|
this |
#performCallback(data) Method
#Declaration
TypeScript
performCallback(
data: any
): Promise<void>
#Parameters
Name | Type |
---|---|
data | any |
#Returns
Type |
---|
Promise |
#performCallback(data, onSuccess) Method
#Declaration
TypeScript
performCallback(
data: any,
onSuccess: () => void
): void
#Parameters
Name | Type |
---|---|
data | any |
on |
() => void |
#prevPage Method
#Declaration
TypeScript
prevPage(): void
#refresh Method
#Declaration
TypeScript
refresh(): void
#selectAllRowsOnPage Method
#Declaration
TypeScript
selectAllRowsOnPage(): void
#selectRowOnPage(visibleIndex) Method
#Declaration
TypeScript
selectRowOnPage(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#selectRowOnPage(visibleIndex, selected) Method
#Declaration
TypeScript
selectRowOnPage(
visibleIndex: number,
selected: boolean
): void
#Parameters
Name | Type |
---|---|
visible |
number |
selected | boolean |
#selectRows Method
#Declaration
TypeScript
selectRows(): void
#selectRowsByKey(key) Method
#Declaration
TypeScript
selectRowsByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#selectRowsByKey(key, selected) Method
#Declaration
TypeScript
selectRowsByKey(
key: any,
selected: boolean
): void
#Parameters
Name | Type |
---|---|
key | any |
selected | boolean |
#selectRowsByKey(keys) Method
#Declaration
TypeScript
selectRowsByKey(
keys: any[]
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
#selectRowsByKey(keys, selected) Method
#Declaration
TypeScript
selectRowsByKey(
keys: any[],
selected: boolean
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
selected | boolean |
#setColumnLayout(columnLayout) Method
#Declaration
TypeScript
setColumnLayout(
columnLayout: any
): void
#Parameters
Name | Type |
---|---|
column |
any |
#setEditValue(column, value) Method
#Declaration
TypeScript
setEditValue(
column: BootstrapGridViewColumn,
value: string
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
value | string |
#setEditValue(columnFieldNameOrId, value) Method
#Declaration
TypeScript
setEditValue(
columnFieldNameOrId: string,
value: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
value | string |
#setEditValue(columnIndex, value) Method
#Declaration
TypeScript
setEditValue(
columnIndex: number,
value: string
): void
#Parameters
Name | Type |
---|---|
column |
number |
value | string |
#setFilterEnabled(isFilterEnabled) Method
#Declaration
TypeScript
setFilterEnabled(
isFilterEnabled: boolean
): void
#Parameters
Name | Type |
---|---|
is |
boolean |
#setFixedColumnScrollableRows(scrollableRowSettings) Method
#Declaration
TypeScript
setFixedColumnScrollableRows(
scrollableRowSettings: any
): void
#Parameters
Name | Type |
---|---|
scrollable |
any |
#setFocusedCell(rowVisibleIndex, columnIndex) Method
#Declaration
TypeScript
setFocusedCell(
rowVisibleIndex: number,
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
row |
number |
column |
number |
#setFocusedRowIndex(visibleIndex) Method
#Declaration
TypeScript
setFocusedRowIndex(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#setHorizontalScrollPosition(position) Method
#Declaration
TypeScript
setHorizontalScrollPosition(
position: number
): void
#Parameters
Name | Type |
---|---|
position | number |
#setSearchPanelCustomEditor(editor) Method
#Declaration
TypeScript
setSearchPanelCustomEditor(
editor: BootstrapClientEdit
): void
#Parameters
Name | Type |
---|---|
editor | Bootstrap |
#setVerticalScrollPosition(position) Method
#Declaration
TypeScript
setVerticalScrollPosition(
position: number
): void
#Parameters
Name | Type |
---|---|
position | number |
#showCustomizationDialog Method
#Declaration
TypeScript
showCustomizationDialog(): void
#showCustomizationWindow Method
#Declaration
TypeScript
showCustomizationWindow(): void
#showFilterControl Method
#Declaration
TypeScript
showFilterControl(): void
#sortBy(column) Method
#Declaration
TypeScript
sortBy(
column: BootstrapGridViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#sortBy(column, sortOrder) Method
#Declaration
TypeScript
sortBy(
column: BootstrapGridViewColumn,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
sort |
string |
#sortBy(column, sortOrder, reset) Method
#Declaration
TypeScript
sortBy(
column: BootstrapGridViewColumn,
sortOrder: string,
reset: boolean
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
sort |
string |
reset | boolean |
#sortBy(column, sortOrder, reset, sortIndex) Method
#Declaration
TypeScript
sortBy(
column: BootstrapGridViewColumn,
sortOrder: string,
reset: boolean,
sortIndex: number
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
sort |
string |
reset | boolean |
sort |
number |
#sortBy(columnFieldNameOrId) Method
#Declaration
TypeScript
sortBy(
columnFieldNameOrId: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
#sortBy(columnFieldNameOrId, sortOrder) Method
#Declaration
TypeScript
sortBy(
columnFieldNameOrId: string,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
sort |
string |
#sortBy(columnFieldNameOrId, sortOrder, reset) Method
#Declaration
TypeScript
sortBy(
columnFieldNameOrId: string,
sortOrder: string,
reset: boolean
): void
#Parameters
Name | Type |
---|---|
column |
string |
sort |
string |
reset | boolean |
#sortBy(columnFieldNameOrId, sortOrder, reset, sortIndex) Method
#Declaration
TypeScript
sortBy(
columnFieldNameOrId: string,
sortOrder: string,
reset: boolean,
sortIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
string |
sort |
string |
reset | boolean |
sort |
number |
#sortBy(columnIndex) Method
#Declaration
TypeScript
sortBy(
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
#sortBy(columnIndex, sortOrder) Method
#Declaration
TypeScript
sortBy(
columnIndex: number,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column |
number |
sort |
string |
#sortBy(columnIndex, sortOrder, reset) Method
#Declaration
TypeScript
sortBy(
columnIndex: number,
sortOrder: string,
reset: boolean
): void
#Parameters
Name | Type |
---|---|
column |
number |
sort |
string |
reset | boolean |
#sortBy(columnIndex, sortOrder, reset, sortIndex) Method
#Declaration
TypeScript
sortBy(
columnIndex: number,
sortOrder: string,
reset: boolean,
sortIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
sort |
string |
reset | boolean |
sort |
number |
#startEditRow(visibleIndex) Method
#Declaration
TypeScript
startEditRow(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#startEditRowByKey(key) Method
#Declaration
TypeScript
startEditRowByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#ungroup(column) Method
#Declaration
TypeScript
ungroup(
column: BootstrapGridViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#ungroup(columnFieldNameOrId) Method
#Declaration
TypeScript
ungroup(
columnFieldNameOrId: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
#ungroup(columnIndex) Method
#Declaration
TypeScript
ungroup(
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
#unselectAllRowsOnPage Method
#Declaration
TypeScript
unselectAllRowsOnPage(): void
#unselectFilteredRows Method
#Declaration
TypeScript
unselectFilteredRows(): void
#unselectRowOnPage(visibleIndex) Method
#Declaration
TypeScript
unselectRowOnPage(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#unselectRows Method
#Declaration
TypeScript
unselectRows(): void
#unselectRowsByKey(key) Method
#Declaration
TypeScript
unselectRowsByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#unselectRowsByKey(keys) Method
#Declaration
TypeScript
unselectRowsByKey(
keys: any[]
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
#updateEdit Method
#Declaration
TypeScript
updateEdit(): void