BootstrapCardView Class
In This Article
#Declaration
TypeScript
class BootstrapCardView extends BootstrapGridBase
#Remarks
IMPORTANT
Bootstrap Controls for ASP.
#Inherited Members
#Inheritance
Control
BootstrapGridBase
BootstrapCardView
#Properties
#batchEditApi Property
#Declaration
TypeScript
readonly batchEditApi: BootstrapCardViewBatchEditApi | null
#Property Value
Type |
---|
Bootstrap |
null |
#Methods
#addNewCard Method
#Declaration
TypeScript
addNewCard(): void
#applyFilter(filterExpression) Method
#Declaration
TypeScript
applyFilter(
filterExpression: string
): void
#Parameters
Name | Type |
---|---|
filter |
string |
#applySearchPanelFilter(value) Method
#Declaration
TypeScript
applySearchPanelFilter(
value: string
): void
#Parameters
Name | Type |
---|---|
value | string |
#cancelEdit Method
#Declaration
TypeScript
cancelEdit(): void
#clearFilter Method
#Declaration
TypeScript
clearFilter(): void
#closeFilterControl Method
#Declaration
TypeScript
closeFilterControl(): void
#deleteCard(visibleIndex) Method
#Declaration
TypeScript
deleteCard(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#deleteCardByKey(key) Method
#Declaration
TypeScript
deleteCardByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#focus Method
#Declaration
TypeScript
focus(): void
#focusEditor(column) Method
#Declaration
TypeScript
focusEditor(
column: BootstrapCardViewColumn
): 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 |
#getCardKey(visibleIndex) Method
#Declaration
TypeScript
getCardKey(
visibleIndex: number
): string
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
string |
#getColumn(columnIndex) Method
#Declaration
TypeScript
getColumn(
columnIndex: number
): BootstrapCardViewColumn | null
#Parameters
Name | Type |
---|---|
column |
number |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnByField(columnFieldName) Method
#Declaration
TypeScript
getColumnByField(
columnFieldName: string
): BootstrapCardViewColumn | null
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnById(columnId) Method
#Declaration
TypeScript
getColumnById(
columnId: string
): BootstrapCardViewColumn | null
#Parameters
Name | Type |
---|---|
column |
string |
#Returns
Type |
---|
Bootstrap |
null |
#getColumnCount Method
#Declaration
TypeScript
getColumnCount(): number
#Returns
Type |
---|
number |
#getEditor(column) Method
#Declaration
TypeScript
getEditor(
column: BootstrapCardViewColumn
): 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: BootstrapCardViewColumn
): 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 |
#getFocusedCardIndex Method
#Declaration
TypeScript
getFocusedCardIndex(): number
#Returns
Type |
---|
number |
#getFocusedCell Method
#Declaration
TypeScript
getFocusedCell(): BootstrapCardViewCellInfo | null
#Returns
Type |
---|
Bootstrap |
null |
#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 |
#getSelectedCardCount Method
#Declaration
TypeScript
getSelectedCardCount(): number
#Returns
Type |
---|
number |
#getSelectedKeysOnPage Method
#Declaration
TypeScript
getSelectedKeysOnPage(): any[]
#Returns
Type |
---|
any[] |
#getTopVisibleIndex Method
#Declaration
TypeScript
getTopVisibleIndex(): number
#Returns
Type |
---|
number |
#getVerticalScrollPosition Method
#Declaration
TypeScript
getVerticalScrollPosition(): number
#Returns
Type |
---|
number |
#getVisibleCardsOnPage Method
#Declaration
TypeScript
getVisibleCardsOnPage(): number
#Returns
Type |
---|
number |
#gotoPage(pageIndex) Method
#Declaration
TypeScript
gotoPage(
pageIndex: number
): void
#Parameters
Name | Type |
---|---|
page |
number |
#hideCustomizationWindow Method
#Declaration
TypeScript
hideCustomizationWindow(): void
#isCardSelectedOnPage(visibleIndex) Method
#Declaration
TypeScript
isCardSelectedOnPage(
visibleIndex: number
): boolean
#Parameters
Name | Type |
---|---|
visible |
number |
#Returns
Type |
---|
boolean |
#isCustomizationWindowVisible Method
#Declaration
TypeScript
isCustomizationWindowVisible(): boolean
#Returns
Type |
---|
boolean |
#isEditing Method
#Declaration
TypeScript
isEditing(): boolean
#Returns
Type |
---|
boolean |
#isNewCardEditing Method
#Declaration
TypeScript
isNewCardEditing(): boolean
#Returns
Type |
---|
boolean |
#moveColumn(column) Method
#Declaration
TypeScript
moveColumn(
column: BootstrapCardViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#moveColumn(column, moveToColumnVisibleIndex) Method
#Declaration
TypeScript
moveColumn(
column: BootstrapCardViewColumn,
moveToColumnVisibleIndex: number
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
move |
number |
#moveColumn(column, moveToColumnVisibleIndex, moveBefore) Method
#Declaration
TypeScript
moveColumn(
column: BootstrapCardViewColumn,
moveToColumnVisibleIndex: number,
moveBefore: boolean
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
move |
number |
move |
boolean |
#moveColumn(columnFieldNameOrId) Method
#Declaration
TypeScript
moveColumn(
columnFieldNameOrId: string
): void
#Parameters
Name | Type |
---|---|
column |
string |
#moveColumn(columnFieldNameOrId, moveToColumnVisibleIndex) Method
#Declaration
TypeScript
moveColumn(
columnFieldNameOrId: string,
moveToColumnVisibleIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
string |
move |
number |
#moveColumn(columnFieldNameOrId, moveToColumnVisibleIndex, moveBefore) Method
#Declaration
TypeScript
moveColumn(
columnFieldNameOrId: string,
moveToColumnVisibleIndex: number,
moveBefore: boolean
): void
#Parameters
Name | Type |
---|---|
column |
string |
move |
number |
move |
boolean |
#moveColumn(columnIndex) Method
#Declaration
TypeScript
moveColumn(
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
#moveColumn(columnIndex, moveToColumnVisibleIndex) Method
#Declaration
TypeScript
moveColumn(
columnIndex: number,
moveToColumnVisibleIndex: number
): void
#Parameters
Name | Type |
---|---|
column |
number |
move |
number |
#moveColumn(columnIndex, moveToColumnVisibleIndex, moveBefore) Method
#Declaration
TypeScript
moveColumn(
columnIndex: number,
moveToColumnVisibleIndex: number,
moveBefore: boolean
): void
#Parameters
Name | Type |
---|---|
column |
number |
move |
number |
move |
boolean |
#nextPage Method
#Declaration
TypeScript
nextPage(): void
#off<K> Method
#Declaration
TypeScript
off<K extends keyof BootstrapCardViewEventMap>(
eventName?: K,
callback?: (this: BootstrapCardView,
args?: BootstrapCardViewEventMap[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 BootstrapCardViewEventMap>(
eventName: K,
callback: (this: BootstrapCardView,
args?: BootstrapCardViewEventMap[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 BootstrapCardViewEventMap>(
eventName: K,
callback: (this: BootstrapCardView,
args?: BootstrapCardViewEventMap[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
#selectAllCardsOnPage Method
#Declaration
TypeScript
selectAllCardsOnPage(): void
#selectCardOnPage(visibleIndex) Method
#Declaration
TypeScript
selectCardOnPage(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#selectCardOnPage(visibleIndex, selected) Method
#Declaration
TypeScript
selectCardOnPage(
visibleIndex: number,
selected: boolean
): void
#Parameters
Name | Type |
---|---|
visible |
number |
selected | boolean |
#selectCards Method
#Declaration
TypeScript
selectCards(): void
#selectCardsByKey(key) Method
#Declaration
TypeScript
selectCardsByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#selectCardsByKey(key, selected) Method
#Declaration
TypeScript
selectCardsByKey(
key: any,
selected: boolean
): void
#Parameters
Name | Type |
---|---|
key | any |
selected | boolean |
#selectCardsByKey(keys) Method
#Declaration
TypeScript
selectCardsByKey(
keys: any[]
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
#selectCardsByKey(keys, selected) Method
#Declaration
TypeScript
selectCardsByKey(
keys: any[],
selected: boolean
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
selected | boolean |
#setEditValue(column, value) Method
#Declaration
TypeScript
setEditValue(
column: BootstrapCardViewColumn,
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 |
#setFocusedCardIndex(visibleIndex) Method
#Declaration
TypeScript
setFocusedCardIndex(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#setFocusedCell(cardVisibleIndex, columnIndex) Method
#Declaration
TypeScript
setFocusedCell(
cardVisibleIndex: number,
columnIndex: number
): void
#Parameters
Name | Type |
---|---|
card |
number |
column |
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 |
#showCustomizationWindow Method
#Declaration
TypeScript
showCustomizationWindow(): void
#showFilterControl Method
#Declaration
TypeScript
showFilterControl(): void
#sortBy(column) Method
#Declaration
TypeScript
sortBy(
column: BootstrapCardViewColumn
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
#sortBy(column, sortOrder) Method
#Declaration
TypeScript
sortBy(
column: BootstrapCardViewColumn,
sortOrder: string
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
sort |
string |
#sortBy(column, sortOrder, reset) Method
#Declaration
TypeScript
sortBy(
column: BootstrapCardViewColumn,
sortOrder: string,
reset: boolean
): void
#Parameters
Name | Type |
---|---|
column | Bootstrap |
sort |
string |
reset | boolean |
#sortBy(column, sortOrder, reset, sortIndex) Method
#Declaration
TypeScript
sortBy(
column: BootstrapCardViewColumn,
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 |
#startEditCard(visibleIndex) Method
#Declaration
TypeScript
startEditCard(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#startEditCardByKey(key) Method
#Declaration
TypeScript
startEditCardByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#unselectAllCardsOnPage Method
#Declaration
TypeScript
unselectAllCardsOnPage(): void
#unselectCardOnPage(visibleIndex) Method
#Declaration
TypeScript
unselectCardOnPage(
visibleIndex: number
): void
#Parameters
Name | Type |
---|---|
visible |
number |
#unselectCards Method
#Declaration
TypeScript
unselectCards(): void
#unselectCardsByKey(key) Method
#Declaration
TypeScript
unselectCardsByKey(
key: any
): void
#Parameters
Name | Type |
---|---|
key | any |
#unselectCardsByKey(keys) Method
#Declaration
TypeScript
unselectCardsByKey(
keys: any[]
): void
#Parameters
Name | Type |
---|---|
keys | any[] |
#unselectFilteredCards Method
#Declaration
TypeScript
unselectFilteredCards(): void
#updateEdit Method
#Declaration
TypeScript
updateEdit(): void