The requested page is not available for the requested platform. You are viewing the content for Default platform.

BootstrapComboBox Class

Declaration

export class BootstrapComboBox 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.

Inheritance

BootstrapClientEdit
BootstrapComboBox

Methods

addItem Method

Adds a new item to the editor specifying the item's display text and returns the index of the added item.

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

adjustDropDownWindow Method

Declaration

adjustDropDownWindow(): void

beginUpdate Method

Prevents the client combo box editor from being rendered until the EndUpdate method is called.

Declaration

beginUpdate(): void

clearItems Method

Removes all items from the client combo box editor.

Declaration

clearItems(): void

endUpdate Method

Re-enables editor render operations after a call to the BeginUpdate method and forces an immediate re-rendering.

Declaration

endUpdate(): void

ensureDropDownLoaded Method

Declaration

ensureDropDownLoaded(callbackFunction: any): void

Parameters

Name Type Description
callbackFunction

findItemByText Method

Returns a combo box item by its text.

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Name Type Description
text

Returns

Type Description
BootstrapListBoxItem
null

findItemByValue Method

Returns a combo box item by its value.

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Name Type Description
value

Returns

Type Description
BootstrapListBoxItem
null

getButtonVisible Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Name Type Description
number

Returns

Type Description
boolean

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type Description
number

getItem Method

Returns an item specified by its index within the combo box editor's item collection.

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

Gets the number of items contained in the editor's item collection.

Declaration

getItemCount(): number

Returns

Type Description
number

getSelectedIndex Method

Returns the index of the selected item within the combo box editor.

Declaration

getSelectedIndex(): number

Returns

Type Description
number

getSelectedItem Method

Returns the combo box editor's selected item.

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type Description
BootstrapListBoxItem
null

getText Method

Gets the text displayed in the editor's edit box.

Declaration

getText(): string

Returns

Type Description
string

hideDropDown Method

Declaration

hideDropDown(): void

insertItem Method

Inserts a new item specified by its display text into the editor's item collection, at the position specified.

Declaration

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

Parameters

Name Type Description
index
texts

makeItemVisible Method

Scrolls the editor's item list, so that the specified item becomes visible.

Declaration

makeItemVisible(index: number): void

Parameters

Name Type Description
index

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

performCallback Method

Sends a callback to the server and generates the server-side ASPxAutoCompleteBoxBase.Callback event, passing it the specified argument.

Declaration

performCallback(data: any): Promise<void>

Parameters

Name Type Description
data

Returns

Type Description
Promise<void>

removeItem Method

Removes an item specified by its index from the client list editor.

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

setButtonVisible Method

Declaration

setButtonVisible(number: number, value: boolean): void

Parameters

Name Type Description
number
value

setCaretPosition Method

Declaration

setCaretPosition(position: number): void

Parameters

Name Type Description
position

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

Sets the combo box editor's selected item specified by its index.

Declaration

setSelectedIndex(index: number): void

Parameters

Name Type Description
index

setSelectedItem Method

Sets the list editor's selected item.

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Name Type Description
item

setSelection Method

Declaration

setSelection(startPos: number, endPos: number, scrollToSelection: boolean): void

Parameters

Name Type Description
startPos
endPos
scrollToSelection

setText Method

Specifies the text displayed within the editor's edit box.

Declaration

setText(text: string, applyFilter: boolean): void

Parameters

Name Type Description
text
applyFilter

showDropDown Method

Declaration

showDropDown(): void