Skip to main content

BootstrapComboBox Class

In This Article
Methods

#Declaration

TypeScript
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

#Methods

#addItem(text) Method

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

#Declaration

TypeScript
addItem(
    text: string
): number

#Parameters

Name Type
text string

#Returns

Type
number

#addItem(text, value) Method

#Declaration

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

#Parameters

Name Type
text string
value any

#Returns

Type
number

#addItem(text, value, iconCssClass) Method

#Declaration

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

#Parameters

Name Type
text string
value any
iconCssClass string

#Returns

Type
number

#addItem(texts) Method

#Declaration

TypeScript
addItem(
    texts: string[]
): number

#Parameters

Name Type
texts string[]

#Returns

Type
number

#addItem(texts, value) Method

#Declaration

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

#Parameters

Name Type
texts string[]
value any

#Returns

Type
number

#addItem(texts, value, iconCssClass) Method

#Declaration

TypeScript
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

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

#Parameters

Name Type
index number
className string

#addItemTextCellCssClass(itemIndex, textCellIndex, className) Method

#Declaration

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

#Parameters

Name Type
itemIndex number
textCellIndex number
className string

#adjustDropDownWindow Method

#Declaration

TypeScript
adjustDropDownWindow(): void

#beginUpdate Method

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

#Declaration

TypeScript
beginUpdate(): void

#clearItems Method

Removes all items from the client combo box editor.

#Declaration

TypeScript
clearItems(): void

#endUpdate Method

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

#Declaration

TypeScript
endUpdate(): void

#ensureDropDownLoaded(callbackFunction) Method

#Declaration

TypeScript
ensureDropDownLoaded(
    callbackFunction: any
): void

#Parameters

Name Type
callbackFunction any

#findItemByText(text) Method

Returns a combo box item by its text.

#Declaration

TypeScript
findItemByText(
    text: string
): BootstrapListBoxItem | null

#Parameters

Name Type
text string

#Returns

Type
BootstrapListBoxItem
null

#findItemByValue(value) Method

Returns a combo box item by its value.

#Declaration

TypeScript
findItemByValue(
    value: any
): BootstrapListBoxItem | null

#Parameters

Name Type
value any

#Returns

Type
BootstrapListBoxItem
null

#getButtonVisible(number) Method

#Declaration

TypeScript
getButtonVisible(
    number: number
): boolean

#Parameters

Name Type
number number

#Returns

Type
boolean

#getCaretPosition Method

#Declaration

TypeScript
getCaretPosition(): number

#Returns

Type
number

#getItem(index) Method

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

#Declaration

TypeScript
getItem(
    index: number
): BootstrapListBoxItem | null

#Parameters

Name Type
index number

#Returns

Type
BootstrapListBoxItem
null

#getItemBadgeIconCssClass(index) Method

#Declaration

TypeScript
getItemBadgeIconCssClass(
    index: number
): string

#Parameters

Name Type
index number

#Returns

Type
string

#getItemBadgeText(index) Method

#Declaration

TypeScript
getItemBadgeText(
    index: number
): string

#Parameters

Name Type
index number

#Returns

Type
string

#getItemCount Method

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

#Declaration

TypeScript
getItemCount(): number

#Returns

Type
number

#getSelectedIndex Method

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

#Declaration

TypeScript
getSelectedIndex(): number

#Returns

Type
number

#getSelectedItem Method

Returns the combo box editor’s selected item.

#Declaration

TypeScript
getSelectedItem(): BootstrapListBoxItem | null

#Returns

Type
BootstrapListBoxItem
null

#getText Method

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

#Declaration

TypeScript
getText(): string

#Returns

Type
string

#hideDropDown Method

#Declaration

TypeScript
hideDropDown(): void

#insertItem(index, text) Method

#Declaration

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

#Parameters

Name Type
index number
text string

#insertItem(index, text, value) Method

#Declaration

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

#Parameters

Name Type
index number
text string
value any

#insertItem(index, text, value, iconCssClass) Method

#Declaration

TypeScript
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

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

#Declaration

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

#Parameters

Name Type
index number
texts string[]

#insertItem(index, texts, value) Method

#Declaration

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

#Parameters

Name Type
index number
texts string[]
value any

#insertItem(index, texts, value, iconCssClass) Method

#Declaration

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

#Parameters

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

#makeItemVisible(index) Method

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

#Declaration

TypeScript
makeItemVisible(
    index: number
): void

#Parameters

Name Type
index number

#off<K> Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#on<K>(eventName, callback) Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#once<K>(eventName, callback) Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#performCallback(data) Method

#Declaration

TypeScript
performCallback(
    data: any
): Promise<void>

#Parameters

Name Type
data any

#Returns

Type
Promise<void>

#performCallback(data, onSuccess) Method

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

#Declaration

TypeScript
performCallback(
    data: any,
    onSuccess: () => void
): void

#Parameters

Name Type
data any
onSuccess () => void

#removeItem(index) Method

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

#Declaration

TypeScript
removeItem(
    index: number
): void

#Parameters

Name Type
index number

#removeItemCssClass(index, className) Method

#Declaration

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

#Parameters

Name Type
index number
className string

#removeItemTextCellCssClass(itemIndex, textCellIndex, className) Method

#Declaration

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

#Parameters

Name Type
itemIndex number
textCellIndex number
className string

#selectAll Method

#Declaration

TypeScript
selectAll(): void

#setButtonVisible(number, value) Method

#Declaration

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

#Parameters

Name Type
number number
value boolean

#setCaretPosition(position) Method

#Declaration

TypeScript
setCaretPosition(
    position: number
): void

#Parameters

Name Type
position number

#setItemBadgeIconCssClass(index, cssClass) Method

#Declaration

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

#Parameters

Name Type
index number
cssClass string

#setItemBadgeText(index, text) Method

#Declaration

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

#Parameters

Name Type
index number
text string

#setItemHtml(index, html) Method

#Declaration

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

#Parameters

Name Type
index number
html string

#setItemTextCellHtml(itemIndex, textCellIndex, html) Method

#Declaration

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

#Parameters

Name Type
itemIndex number
textCellIndex number
html string

#setItemTextCellTooltip(itemIndex, textCellIndex, tooltip) Method

#Declaration

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

#Parameters

Name Type
itemIndex number
textCellIndex number
tooltip string

#setItemTooltip(index, tooltip) Method

#Declaration

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

#Parameters

Name Type
index number
tooltip string

#setSelectedIndex(index) Method

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

#Declaration

TypeScript
setSelectedIndex(
    index: number
): void

#Parameters

Name Type
index number

#setSelectedItem(item) Method

Sets the list editor’s selected item.

#Declaration

TypeScript
setSelectedItem(
    item: BootstrapListBoxItem
): void

#Parameters

Name Type
item BootstrapListBoxItem

#setSelection(startPos, endPos, scrollToSelection) Method

#Declaration

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

#Parameters

Name Type
startPos number
endPos number
scrollToSelection boolean

#setText(text, applyFilter) Method

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

#Declaration

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

#Parameters

Name Type
text string
applyFilter boolean

#showDropDown Method

#Declaration

TypeScript
showDropDown(): void