BootstrapListBox Class

Declaration

export class BootstrapListBox extends BootstrapClientEdit

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.

Methods

addItem Method

Declaration

addItem(texts: array[string]): number

Parameters

Name Type Description
texts

Returns

Type Description
number

addItemCssClass Method

Declaration

addItemCssClass(index: number, className: string): void

Parameters

Name Type Description
index
className

addItemTextCellCssClass Method

Declaration

addItemTextCellCssClass(itemIndex: number, textCellIndex: number, className: string): void

Parameters

Name Type Description
itemIndex
textCellIndex
className

beginUpdate Method

Declaration

beginUpdate(): void

clearItems Method

Declaration

clearItems(): void

endUpdate Method

Declaration

endUpdate(): void

findItemByText Method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Name Type Description
text

Returns

Type Description
BootstrapListBoxItem
null

findItemByValue Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Name Type Description
value

Returns

Type Description
BootstrapListBoxItem
null

getItem Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Name Type Description
index

Returns

Type Description
BootstrapListBoxItem
null

getItemBadgeIconCssClass Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Name Type Description
index

Returns

Type Description
string

getItemBadgeText Method

Declaration

getItemBadgeText(index: number): string

Parameters

Name Type Description
index

Returns

Type Description
string

getItemCount Method

Declaration

getItemCount(): number

Returns

Type Description
number

getSelectedIndex Method

Declaration

getSelectedIndex(): number

Returns

Type Description
number

getSelectedIndices Method

Declaration

getSelectedIndices(): array[number]

Returns

Type Description
array[number]

getSelectedItem Method

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type Description
BootstrapListBoxItem
null

getSelectedItems Method

Declaration

getSelectedItems(): array[BootstrapListBoxItem]

Returns

Type Description
array[BootstrapListBoxItem]

getSelectedValues Method

Declaration

getSelectedValues(): array[any]

Returns

Type Description
array[any]

insertItem Method

Declaration

insertItem(index: number, texts: array[string]): void

Parameters

Name Type Description
index
texts

makeItemVisible Method

Declaration

makeItemVisible(index: number): void

Parameters

Name Type Description
index

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

once(eventName: K, callback: (this: BootstrapListBox, args?: BootstrapListBoxEventMap[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>

removeItem Method

Declaration

removeItem(index: number): void

Parameters

Name Type Description
index

removeItemCssClass Method

Declaration

removeItemCssClass(index: number, className: string): void

Parameters

Name Type Description
index
className

removeItemTextCellCssClass Method

Declaration

removeItemTextCellCssClass(itemIndex: number, textCellIndex: number, className: string): void

Parameters

Name Type Description
itemIndex
textCellIndex
className

selectAll Method

Declaration

selectAll(): void

selectIndices Method

Declaration

selectIndices(indices: array[number]): void

Parameters

Name Type Description
indices

selectItems Method

Declaration

selectItems(items: array[BootstrapListBoxItem]): void

Parameters

Name Type Description
items

selectValues Method

Declaration

selectValues(values: array[any]): void

Parameters

Name Type Description
values

setItemBadgeIconCssClass Method

Declaration

setItemBadgeIconCssClass(index: number, cssClass: string): void

Parameters

Name Type Description
index
cssClass

setItemBadgeText Method

Declaration

setItemBadgeText(index: number, text: string): void

Parameters

Name Type Description
index
text

setItemHtml Method

Declaration

setItemHtml(index: number, html: string): void

Parameters

Name Type Description
index
html

setItemTextCellHtml Method

Declaration

setItemTextCellHtml(itemIndex: number, textCellIndex: number, html: string): void

Parameters

Name Type Description
itemIndex
textCellIndex
html

setItemTextCellTooltip Method

Declaration

setItemTextCellTooltip(itemIndex: number, textCellIndex: number, tooltip: string): void

Parameters

Name Type Description
itemIndex
textCellIndex
tooltip

setItemTooltip Method

Declaration

setItemTooltip(index: number, tooltip: string): void

Parameters

Name Type Description
index
tooltip

setSelectedIndex Method

Declaration

setSelectedIndex(index: number): void

Parameters

Name Type Description
index

setSelectedItem Method

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Name Type Description
item

unselectAll Method

Declaration

unselectAll(): void

unselectIndices Method

Declaration

unselectIndices(indices: array[number]): void

Parameters

Name Type Description
indices

unselectItems Method

Declaration

unselectItems(items: array[BootstrapListBoxItem]): void

Parameters

Name Type Description
items

unselectValues Method

Declaration

unselectValues(values: array[any]): void

Parameters

Name Type Description
values