BootstrapTagBox Class

Declaration

export class BootstrapTagBox extends BootstrapClientEdit

Inheritance

BootstrapClientEdit
BootstrapTagBox

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

addTag Method

Declaration

addTag(text: string): void

Parameters

Type Name Description
text

adjustDropDownWindow Method

Declaration

adjustDropDownWindow(): void

beginUpdate Method

Declaration

beginUpdate(): void

clearItems Method

Declaration

clearItems(): void

clearTagCollection Method

Declaration

clearTagCollection(): void

endUpdate Method

Declaration

endUpdate(): void

ensureDropDownLoaded Method

Declaration

ensureDropDownLoaded(callbackFunction: any): void

Parameters

Type Name Description
callbackFunction

findItemByText Method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Type Name Description
text

Returns

Type Description

findItemByValue Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Type Name Description
value

Returns

Type Description

getButtonVisible Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Type Name Description
number

Returns

Type Description

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type Description

getItem Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Type Name Description
index

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

getTagCollection Method

Declaration

getTagCollection(): array[string]

Returns

Type Description

getTagHtmlElement Method

Declaration

getTagHtmlElement(index: number): any

Parameters

Type Name Description
index

Returns

Type Description

getTagIndexByText Method

Declaration

getTagIndexByText(text: string): number

Parameters

Type Name Description
text

Returns

Type Description

getTagRemoveButtonHtmlElement Method

Declaration

getTagRemoveButtonHtmlElement(index: number): any

Parameters

Type Name Description
index

Returns

Type Description

getTagTextHtmlElement Method

Declaration

getTagTextHtmlElement(index: number): any

Parameters

Type Name Description
index

Returns

Type Description

getText Method

Declaration

getText(): string

Returns

Type Description

getValue Method

Declaration

getValue(): string

Returns

Type Description

hideDropDown Method

Declaration

hideDropDown(): void

insertItem Method

Declaration

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

Parameters

Type Name Description
index
texts

isCustomTag Method

Declaration

isCustomTag(text: string, caseSensitive: boolean): boolean

Parameters

Type Name Description
text
caseSensitive

Returns

Type Description

makeItemVisible Method

Declaration

makeItemVisible(index: number): void

Parameters

Type Name Description
index

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

once Method

Declaration

once(eventName: K, callback: (this: BootstrapTagBox, args?: BootstrapTagBoxEventMap[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

removeTag Method

Declaration

removeTag(index: number): void

Parameters

Type Name Description
index

removeTagByText Method

Declaration

removeTagByText(text: string): void

Parameters

Type Name Description
text

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

setSelection Method

Declaration

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

Parameters

Type Name Description
startPos
endPos
scrollToSelection

setTagCollection Method

Declaration

setTagCollection(collection: array[string]): void

Parameters

Type Name Description
collection

setText Method

Declaration

setText(text: string): void

Parameters

Type Name Description
text

setValue Method

Declaration

setValue(value: string): void

Parameters

Type Name Description
value

showDropDown Method

Declaration

showDropDown(): void