BootstrapCardView Class

Declaration

class BootstrapCardView 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.

Inherited Members

name

adjustControl

getHeight

getMainElement

getParentControl

getToolbar(index)

getToolbarByName(name)

getVisible

getWidth

inCallback

sendMessageToAssistiveTechnology(message)

setHeight(height)

setVisible(visible)

setWidth(width)

Inheritance

Control

BootstrapGridBase

BootstrapCardView

Properties

batchEditApi Property

Declaration

readonly batchEditApi: BootstrapCardViewBatchEditApi | null

Property Value

Type
BootstrapCardViewBatchEditApi
null

Methods

addNewCard Method

Declaration

addNewCard(): void

applyFilter(filterExpression) Method

Declaration

applyFilter(
    filterExpression: string
): void

Parameters

Name	Type
filterExpression	string

applySearchPanelFilter(value) Method

Declaration

applySearchPanelFilter(
    value: string
): void

Parameters

Name	Type
value	string

cancelEdit Method

Declaration

cancelEdit(): void

clearFilter Method

Declaration

clearFilter(): void

closeFilterControl Method

Declaration

closeFilterControl(): void

deleteCard(visibleIndex) Method

Declaration

deleteCard(
    visibleIndex: number
): void

Parameters

Name	Type
visibleIndex	number

deleteCardByKey(key) Method

Declaration

deleteCardByKey(
    key: any
): void

Parameters

Name	Type
key	any

focus Method

Declaration

focus(): void

focusEditor(column) Method

Declaration

focusEditor(
    column: BootstrapCardViewColumn
): void

Parameters

Name	Type
column	BootstrapCardViewColumn

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

getCardKey(visibleIndex) Method

Declaration

getCardKey(
    visibleIndex: number
): string

Parameters

Name	Type
visibleIndex	number

Returns

Type
string

getColumn(columnIndex) Method

Declaration

getColumn(
    columnIndex: number
): BootstrapCardViewColumn | null

Parameters

Name	Type
columnIndex	number

Returns

Type
BootstrapCardViewColumn
null

getColumnByField(columnFieldName) Method

Declaration

getColumnByField(
    columnFieldName: string
): BootstrapCardViewColumn | null

Parameters

Name	Type
columnFieldName	string

Returns

Type
BootstrapCardViewColumn
null

getColumnById(columnId) Method

Declaration

getColumnById(
    columnId: string
): BootstrapCardViewColumn | null

Parameters

Name	Type
columnId	string

Returns

Type
BootstrapCardViewColumn
null

getColumnCount Method

Declaration

getColumnCount(): number

Returns

Type
number

getEditor(column) Method

Declaration

getEditor(
    column: BootstrapCardViewColumn
): BootstrapClientEdit

Parameters

Name	Type
column	BootstrapCardViewColumn

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: BootstrapCardViewColumn
): string

Parameters

Name	Type
column	BootstrapCardViewColumn

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

getFocusedCardIndex Method

Declaration

getFocusedCardIndex(): number

Returns

Type
number

getFocusedCell Method

Declaration

getFocusedCell(): BootstrapCardViewCellInfo | null

Returns

Type
BootstrapCardViewCellInfo
null

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

getSelectedCardCount Method

Declaration

getSelectedCardCount(): number

Returns

Type
number

getSelectedKeysOnPage Method

Declaration

getSelectedKeysOnPage(): any[]

Returns

Type
any[]

getTopVisibleIndex Method

Declaration

getTopVisibleIndex(): number

Returns

Type
number

getVerticalScrollPosition Method

Declaration

getVerticalScrollPosition(): number

Returns

Type
number

getVisibleCardsOnPage Method

Declaration

getVisibleCardsOnPage(): number

Returns

Type
number

gotoPage(pageIndex) Method

Declaration

gotoPage(
    pageIndex: number
): void

Parameters

Name	Type
pageIndex	number

hideCustomizationWindow Method

Declaration

hideCustomizationWindow(): void

isCardSelectedOnPage(visibleIndex) Method

Declaration

isCardSelectedOnPage(
    visibleIndex: number
): boolean

Parameters

Name	Type
visibleIndex	number

Returns

Type
boolean

isCustomizationWindowVisible Method

Declaration

isCustomizationWindowVisible(): boolean

Returns

Type
boolean

isEditing Method

Declaration

isEditing(): boolean

Returns

Type
boolean

isNewCardEditing Method

Declaration

isNewCardEditing(): boolean

Returns

Type
boolean

moveColumn(column) Method

Declaration

moveColumn(
    column: BootstrapCardViewColumn
): void

Parameters

Name	Type
column	BootstrapCardViewColumn

moveColumn(column, moveToColumnVisibleIndex) Method

Declaration

moveColumn(
    column: BootstrapCardViewColumn,
    moveToColumnVisibleIndex: number
): void

Parameters

Name	Type
column	BootstrapCardViewColumn
moveToColumnVisibleIndex	number

moveColumn(column, moveToColumnVisibleIndex, moveBefore) Method

Declaration

moveColumn(
    column: BootstrapCardViewColumn,
    moveToColumnVisibleIndex: number,
    moveBefore: boolean
): void

Parameters

Name	Type
column	BootstrapCardViewColumn
moveToColumnVisibleIndex	number
moveBefore	boolean

moveColumn(columnFieldNameOrId) Method

Declaration

moveColumn(
    columnFieldNameOrId: string
): void

Parameters

Name	Type
columnFieldNameOrId	string

moveColumn(columnFieldNameOrId, moveToColumnVisibleIndex) Method

Declaration

moveColumn(
    columnFieldNameOrId: string,
    moveToColumnVisibleIndex: number
): void

Parameters

Name	Type
columnFieldNameOrId	string
moveToColumnVisibleIndex	number

moveColumn(columnFieldNameOrId, moveToColumnVisibleIndex, moveBefore) Method

Declaration

moveColumn(
    columnFieldNameOrId: string,
    moveToColumnVisibleIndex: number,
    moveBefore: boolean
): void

Parameters

Name	Type
columnFieldNameOrId	string
moveToColumnVisibleIndex	number
moveBefore	boolean

moveColumn(columnIndex) Method

Declaration

moveColumn(
    columnIndex: number
): void

Parameters

Name	Type
columnIndex	number

moveColumn(columnIndex, moveToColumnVisibleIndex) Method

Declaration

moveColumn(
    columnIndex: number,
    moveToColumnVisibleIndex: number
): void

Parameters

Name	Type
columnIndex	number
moveToColumnVisibleIndex	number

moveColumn(columnIndex, moveToColumnVisibleIndex, moveBefore) Method

Declaration

moveColumn(
    columnIndex: number,
    moveToColumnVisibleIndex: number,
    moveBefore: boolean
): void

Parameters

Name	Type
columnIndex	number
moveToColumnVisibleIndex	number
moveBefore	boolean

nextPage Method

Declaration

nextPage(): void

off<K> Method

Declaration

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

Parameters

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

Type Parameters

Name	Type
K	keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name	Type
K	keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

Name	Type
eventName	K
callback	(this: BootstrapCardView, args?: BootstrapCardViewEventMap[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

selectAllCardsOnPage Method

Declaration

selectAllCardsOnPage(): void

selectCardOnPage(visibleIndex) Method

Declaration

selectCardOnPage(
    visibleIndex: number
): void

Parameters

Name	Type
visibleIndex	number

selectCardOnPage(visibleIndex, selected) Method

Declaration

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

Parameters

Name	Type
visibleIndex	number
selected	boolean

selectCards Method

Declaration

selectCards(): void

selectCardsByKey(key) Method

Declaration

selectCardsByKey(
    key: any
): void

Parameters

Name	Type
key	any

selectCardsByKey(key, selected) Method

Declaration

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

Parameters

Name	Type
key	any
selected	boolean

selectCardsByKey(keys) Method

Declaration

selectCardsByKey(
    keys: any[]
): void

Parameters

Name	Type
keys	any[]

selectCardsByKey(keys, selected) Method

Declaration

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

Parameters

Name	Type
keys	any[]
selected	boolean

setEditValue(column, value) Method

Declaration

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

Parameters

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

setFocusedCardIndex(visibleIndex) Method

Declaration

setFocusedCardIndex(
    visibleIndex: number
): void

Parameters

Name	Type
visibleIndex	number

setFocusedCell(cardVisibleIndex, columnIndex) Method

Declaration

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

Parameters

Name	Type
cardVisibleIndex	number
columnIndex	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

showCustomizationWindow Method

Declaration

showCustomizationWindow(): void

showFilterControl Method

Declaration

showFilterControl(): void

sortBy(column) Method

Declaration

sortBy(
    column: BootstrapCardViewColumn
): void

Parameters

Name	Type
column	BootstrapCardViewColumn

sortBy(column, sortOrder) Method

Declaration

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

Parameters

Name	Type
column	BootstrapCardViewColumn
sortOrder	string

sortBy(column, sortOrder, reset) Method

Declaration

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

Parameters

Name	Type
column	BootstrapCardViewColumn
sortOrder	string
reset	boolean

sortBy(column, sortOrder, reset, sortIndex) Method

Declaration

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

Parameters

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

startEditCard(visibleIndex) Method

Declaration

startEditCard(
    visibleIndex: number
): void

Parameters

Name	Type
visibleIndex	number

startEditCardByKey(key) Method

Declaration

startEditCardByKey(
    key: any
): void

Parameters

Name	Type
key	any

unselectAllCardsOnPage Method

Declaration

unselectAllCardsOnPage(): void

unselectCardOnPage(visibleIndex) Method

Declaration

unselectCardOnPage(
    visibleIndex: number
): void

Parameters

Name	Type
visibleIndex	number

unselectCards Method

Declaration

unselectCards(): void

unselectCardsByKey(key) Method

Declaration

unselectCardsByKey(
    key: any
): void

Parameters

Name	Type
key	any

unselectCardsByKey(keys) Method

Declaration

unselectCardsByKey(
    keys: any[]
): void

Parameters

Name	Type
keys	any[]

unselectFilteredCards Method

Declaration

unselectFilteredCards(): void

updateEdit Method

Declaration

updateEdit(): void