BootstrapListBox Class

Declaration

export class BootstrapListBox extends BootstrapClientEdit

Methods

addItem Method

Declaration

addItem(texts: array[string]): number

Parameters

Type Name Description
texts

Returns

Type Description

addItemCssClass Method

Declaration

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

Parameters

Type Name Description
index
className

addItemTextCellCssClass Method

Declaration

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

Parameters

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

Type Name Description
text

Returns

Type Description

Returns

Type Description

findItemByValue Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Type Name Description
value

Returns

Type Description

Returns

Type Description

getItem Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Type Name Description
index

Returns

Type Description

Returns

Type Description

getItemBadgeIconCssClass Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Type Name Description
index

Returns

Type Description

getItemBadgeText Method

Declaration

getItemBadgeText(index: number): string

Parameters

Type Name Description
index

Returns

Type Description

getItemCount Method

Declaration

getItemCount(): number

Returns

Type Description

getSelectedIndex Method

Declaration

getSelectedIndex(): number

Returns

Type Description

getSelectedIndices Method

Declaration

getSelectedIndices(): array[number]

Returns

Type Description

getSelectedItem Method

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type Description

Returns

Type Description

getSelectedItems Method

Declaration

getSelectedItems(): array[BootstrapListBoxItem]

Returns

Type Description

getSelectedValues Method

Declaration

getSelectedValues(): array[any]

Returns

Type Description

insertItem Method

Declaration

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

Parameters

Type Name Description
index
texts

makeItemVisible Method

Declaration

makeItemVisible(index: number): void

Parameters

Type Name Description
index

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

performCallback Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Type Name Description
data

Returns

Type Description

removeItem Method

Declaration

removeItem(index: number): void

Parameters

Type Name Description
index

removeItemCssClass Method

Declaration

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

Parameters

Type Name Description
index
className

removeItemTextCellCssClass Method

Declaration

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

Parameters

Type Name Description
itemIndex
textCellIndex
className

selectAll Method

Declaration

selectAll(): void

selectIndices Method

Declaration

selectIndices(indices: array[number]): void

Parameters

Type Name Description
indices

selectItems Method

Declaration

selectItems(items: array[BootstrapListBoxItem]): void

Parameters

Type Name Description
items

selectValues Method

Declaration

selectValues(values: array[any]): void

Parameters

Type Name Description
values

setItemBadgeIconCssClass Method

Declaration

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

Parameters

Type Name Description
index
cssClass

setItemBadgeText Method

Declaration

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

Parameters

Type Name Description
index
text

setItemHtml Method

Declaration

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

Parameters

Type Name Description
index
html

setItemTextCellHtml Method

Declaration

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

Parameters

Type Name Description
itemIndex
textCellIndex
html

setItemTextCellTooltip Method

Declaration

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

Parameters

Type Name Description
itemIndex
textCellIndex
tooltip

setItemTooltip Method

Declaration

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

Parameters

Type Name Description
index
tooltip

setSelectedIndex Method

Declaration

setSelectedIndex(index: number): void

Parameters

Type Name Description
index

setSelectedItem Method

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Type Name Description
item

unselectAll Method

Declaration

unselectAll(): void

unselectIndices Method

Declaration

unselectIndices(indices: array[number]): void

Parameters

Type Name Description
indices

unselectItems Method

Declaration

unselectItems(items: array[BootstrapListBoxItem]): void

Parameters

Type Name Description
items

unselectValues Method

Declaration

unselectValues(values: array[any]): void

Parameters

Type Name Description
values