BootstrapListBox Class

Declaration

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(text) Method

Declaration

addItem(text: string): number

Parameters

Name Type
text string

Returns

Type
number

addItem(text, value) Method

Declaration

addItem(text: string, value: any): number

Parameters

Name Type
text string
value any

Returns

Type
number

addItem(text, value, iconCssClass) Method

Declaration

addItem(text: string, value: any, iconCssClass: string): number

Parameters

Name Type
text string
value any
iconCssClass string

Returns

Type
number

addItem(texts) Method

Declaration

addItem(texts: string[]): number

Parameters

Name Type
texts string[]

Returns

Type
number

addItem(texts, value) Method

Declaration

addItem(texts: string[], value: any): number

Parameters

Name Type
texts string[]
value any

Returns

Type
number

addItem(texts, value, iconCssClass) Method

Declaration

addItem(texts: string[], value: any, iconCssClass: string): number

Parameters

Name Type
texts string[]
value any
iconCssClass string

Returns

Type
number

addItemCssClass(index, className) Method

Declaration

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

Parameters

Name Type
index number
className string

addItemTextCellCssClass(itemIndex, textCellIndex, className) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
className string

beginUpdate Method

Declaration

beginUpdate(): void

clearItems Method

Declaration

clearItems(): void

endUpdate Method

Declaration

endUpdate(): void

findItemByText(text) Method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Name Type
text string

Returns

Type
BootstrapListBoxItem
null

findItemByValue(value) Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Name Type
value any

Returns

Type
BootstrapListBoxItem
null

getItem(index) Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Name Type
index number

Returns

Type
BootstrapListBoxItem
null

getItemBadgeIconCssClass(index) Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Name Type
index number

Returns

Type
string

getItemBadgeText(index) Method

Declaration

getItemBadgeText(index: number): string

Parameters

Name Type
index number

Returns

Type
string

getItemCount Method

Declaration

getItemCount(): number

Returns

Type
number

getSelectedIndex Method

Declaration

getSelectedIndex(): number

Returns

Type
number

getSelectedIndices Method

Declaration

getSelectedIndices(): number[]

Returns

Type
number[]

getSelectedItem Method

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type
BootstrapListBoxItem
null

getSelectedItems Method

Declaration

getSelectedItems(): BootstrapListBoxItem[]

Returns

Type
BootstrapListBoxItem[]

getSelectedValues Method

Declaration

getSelectedValues(): any[]

Returns

Type
any[]

insertItem(index, text) Method

Declaration

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

Parameters

Name Type
index number
text string

insertItem(index, text, value) Method

Declaration

insertItem(index: number, text: string, value: any): void

Parameters

Name Type
index number
text string
value any

insertItem(index, text, value, iconCssClass) Method

Declaration

insertItem(index: number, text: string, value: any, iconCssClass: string): void

Parameters

Name Type
index number
text string
value any
iconCssClass string

insertItem(index, texts) Method

Declaration

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

Parameters

Name Type
index number
texts string[]

insertItem(index, texts, value) Method

Declaration

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

Parameters

Name Type
index number
texts string[]
value any

insertItem(index, texts, value, iconCssClass) Method

Declaration

insertItem(index: number, texts: string[], value: any, iconCssClass: string): void

Parameters

Name Type
index number
texts string[]
value any
iconCssClass string

makeItemVisible(index) Method

Declaration

makeItemVisible(index: number): void

Parameters

Name Type
index number

off<K> Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

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

removeItem(index) Method

Declaration

removeItem(index: number): void

Parameters

Name Type
index number

removeItemCssClass(index, className) Method

Declaration

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

Parameters

Name Type
index number
className string

removeItemTextCellCssClass(itemIndex, textCellIndex, className) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
className string

selectAll Method

Declaration

selectAll(): void

selectIndices(indices) Method

Declaration

selectIndices(indices: number[]): void

Parameters

Name Type
indices number[]

selectItems(items) Method

Declaration

selectItems(items: BootstrapListBoxItem[]): void

Parameters

Name Type
items BootstrapListBoxItem[]

selectValues(values) Method

Declaration

selectValues(values: any[]): void

Parameters

Name Type
values any[]

setItemBadgeIconCssClass(index, cssClass) Method

Declaration

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

Parameters

Name Type
index number
cssClass string

setItemBadgeText(index, text) Method

Declaration

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

Parameters

Name Type
index number
text string

setItemHtml(index, html) Method

Declaration

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

Parameters

Name Type
index number
html string

setItemTextCellHtml(itemIndex, textCellIndex, html) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
html string

setItemTextCellTooltip(itemIndex, textCellIndex, tooltip) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
tooltip string

setItemTooltip(index, tooltip) Method

Declaration

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

Parameters

Name Type
index number
tooltip string

setSelectedIndex(index) Method

Declaration

setSelectedIndex(index: number): void

Parameters

Name Type
index number

setSelectedItem(item) Method

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Name Type
item BootstrapListBoxItem

unselectAll Method

Declaration

unselectAll(): void

unselectIndices(indices) Method

Declaration

unselectIndices(indices: number[]): void

Parameters

Name Type
indices number[]

unselectItems(items) Method

Declaration

unselectItems(items: BootstrapListBoxItem[]): void

Parameters

Name Type
items BootstrapListBoxItem[]

unselectValues(values) Method

Declaration

unselectValues(values: any[]): void

Parameters

Name Type
values any[]