BootstrapComboBox Class

Declaration

export class BootstrapComboBox extends BootstrapClientEdit

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

Type Name Description
texts

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_addItem

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

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

Type Name Description
callbackFunction

findItemByText Method

Returns a combo box item by its text.

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Type Name Description
text

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_findItemByText
js_DevExpress_AspNetCore_BootstrapComboBox_findItemByText

findItemByValue Method

Returns a combo box item by its value.

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Type Name Description
value

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_findItemByValue
js_DevExpress_AspNetCore_BootstrapComboBox_findItemByValue

getButtonVisible Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Type Name Description
number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getButtonVisible

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getCaretPosition

getItem Method

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

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Type Name Description
index

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getItem
js_DevExpress_AspNetCore_BootstrapComboBox_getItem

getItemBadgeIconCssClass Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Type Name Description
index

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getItemBadgeIconCssClass

getItemBadgeText Method

Declaration

getItemBadgeText(index: number): string

Parameters

Type Name Description
index

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getItemBadgeText

getItemCount Method

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

Declaration

getItemCount(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getItemCount

getSelectedIndex Method

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

Declaration

getSelectedIndex(): number

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getSelectedIndex

getSelectedItem Method

Returns the combo box editor's selected item.

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getSelectedItem
js_DevExpress_AspNetCore_BootstrapComboBox_getSelectedItem

getText Method

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

Declaration

getText(): string

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_getText

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

Type Name Description
index
texts

makeItemVisible Method

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

Declaration

makeItemVisible(index: number): void

Parameters

Type Name Description
index

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_off

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_on

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_once

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

Type Name Description
data

Returns

Type Description
js_DevExpress_AspNetCore_BootstrapComboBox_performCallback

removeItem Method

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

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

setButtonVisible Method

Declaration

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

Parameters

Type Name Description
number
value

setCaretPosition Method

Declaration

setCaretPosition(position: number): void

Parameters

Type Name Description
position

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

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

Declaration

setSelectedIndex(index: number): void

Parameters

Type Name Description
index

setSelectedItem Method

Sets the list editor's selected item.

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Type Name Description
item

setSelection Method

Declaration

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

Parameters

Type Name Description
startPos
endPos
scrollToSelection

setText Method

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

Declaration

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

Parameters

Type Name Description
text
applyFilter

showDropDown Method

Declaration

showDropDown(): void