BootstrapTagBox Class

Declaration

export class BootstrapTagBox extends BootstrapClientEdit

Inheritance

Methods

addItem method

Declaration

addItem(texts: array[string]): number

Parameters

Type Name Description
array[string] texts

Returns

Type Description
number

addItemCssClass method

Declaration

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

Parameters

Type Name Description
number index
string className

addItemTextCellCssClass method

Declaration

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

Parameters

Type Name Description
number itemIndex
number textCellIndex
string className

addTag method

Declaration

addTag(text: string): void

Parameters

Type Name Description
string 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
any callbackFunction

findItemByText method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Type Name Description
string text

Returns

Type Description
BootstrapListBoxItem
null

findItemByValue method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Type Name Description
any value

Returns

Type Description
BootstrapListBoxItem
null

getButtonVisible method

Declaration

getButtonVisible(number: number): boolean

Parameters

Type Name Description
number number

Returns

Type Description
boolean

getCaretPosition method

Declaration

getCaretPosition(): number

Returns

Type Description
number

getItem method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Type Name Description
number index

Returns

Type Description
BootstrapListBoxItem
null

getItemBadgeIconCssClass method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Type Name Description
number index

Returns

Type Description
string

getItemBadgeText method

Declaration

getItemBadgeText(index: number): string

Parameters

Type Name Description
number index

Returns

Type Description
string

getItemCount method

Declaration

getItemCount(): number

Returns

Type Description
number

getTagCollection method

Declaration

getTagCollection(): array[string]

Returns

Type Description
array[string]

getTagHtmlElement method

Declaration

getTagHtmlElement(index: number): any

Parameters

Type Name Description
number index

Returns

Type Description
any

getTagIndexByText method

Declaration

getTagIndexByText(text: string): number

Parameters

Type Name Description
string text

Returns

Type Description
number

getTagRemoveButtonHtmlElement method

Declaration

getTagRemoveButtonHtmlElement(index: number): any

Parameters

Type Name Description
number index

Returns

Type Description
any

getTagTextHtmlElement method

Declaration

getTagTextHtmlElement(index: number): any

Parameters

Type Name Description
number index

Returns

Type Description
any

getText method

Declaration

getText(): string

Returns

Type Description
string

getValue method

Declaration

getValue(): string

Returns

Type Description
string

hideDropDown method

Declaration

hideDropDown(): void

insertItem method

Declaration

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

Parameters

Type Name Description
number index
array[string] texts

isCustomTag method

Declaration

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

Parameters

Type Name Description
string text
boolean caseSensitive

Returns

Type Description
boolean

makeItemVisible method

Declaration

makeItemVisible(index: number): void

Parameters

Type Name Description
number index

off method

Declaration

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

Parameters

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

Returns

Type Description
this

on method

Declaration

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

Parameters

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

Returns

Type Description
this

once method

Declaration

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

Parameters

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

Returns

Type Description
this

performCallback method

Declaration

performCallback(data: any): Promise<void>

Parameters

Type Name Description
any data

Returns

Type Description
Promise<void>

removeItem method

Declaration

removeItem(index: number): void

Parameters

Type Name Description
number index

removeItemCssClass method

Declaration

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

Parameters

Type Name Description
number index
string className

removeItemTextCellCssClass method

Declaration

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

Parameters

Type Name Description
number itemIndex
number textCellIndex
string className

removeTag method

Declaration

removeTag(index: number): void

Parameters

Type Name Description
number index

removeTagByText method

Declaration

removeTagByText(text: string): void

Parameters

Type Name Description
string text

selectAll method

Declaration

selectAll(): void

setButtonVisible method

Declaration

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

Parameters

Type Name Description
number number
boolean value

setCaretPosition method

Declaration

setCaretPosition(position: number): void

Parameters

Type Name Description
number position

setItemBadgeIconCssClass method

Declaration

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

Parameters

Type Name Description
number index
string cssClass

setItemBadgeText method

Declaration

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

Parameters

Type Name Description
number index
string text

setItemHtml method

Declaration

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

Parameters

Type Name Description
number index
string html

setItemTextCellHtml method

Declaration

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

Parameters

Type Name Description
number itemIndex
number textCellIndex
string html

setItemTextCellTooltip method

Declaration

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

Parameters

Type Name Description
number itemIndex
number textCellIndex
string tooltip

setItemTooltip method

Declaration

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

Parameters

Type Name Description
number index
string tooltip

setSelection method

Declaration

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

Parameters

Type Name Description
number startPos
number endPos
boolean scrollToSelection

setTagCollection method

Declaration

setTagCollection(collection: array[string]): void

Parameters

Type Name Description
array[string] collection

setText method

Declaration

setText(text: string): void

Parameters

Type Name Description
string text

setValue method

Declaration

setValue(value: string): void

Parameters

Type Name Description
string value

showDropDown method

Declaration

showDropDown(): void