BootstrapTagBox Class

Declaration

class BootstrapTagBox 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

Declaration

addItem(text: string): number

Parameters

Name Type
text string

Returns

Type
number

addItem(text, value) Method

Declaration

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

Parameters

Name Type
text string
value any

Returns

Type
number

addItem(text, value, iconCssClass) Method

Declaration

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

Parameters

Name Type
text string
value any
iconCssClass string

Returns

Type
number

addItem(texts) Method

Declaration

addItem(texts: string[]): number

Parameters

Name Type
texts string[]

Returns

Type
number

addItem(texts, value) Method

Declaration

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

Parameters

Name Type
texts string[]
value any

Returns

Type
number

addItem(texts, value, iconCssClass) Method

Declaration

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

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

Parameters

Name Type
index number
className string

addItemTextCellCssClass(itemIndex, textCellIndex, className) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
className string

addTag(text) Method

Declaration

addTag(text: string): void

Parameters

Name Type
text string

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(callbackFunction) Method

Declaration

ensureDropDownLoaded(callbackFunction: any): void

Parameters

Name Type
callbackFunction any

findItemByText(text) Method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Name Type
text string

Returns

Type
BootstrapListBoxItem
null

findItemByValue(value) Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Name Type
value any

Returns

Type
BootstrapListBoxItem
null

getButtonVisible(number) Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Name Type
number number

Returns

Type
boolean

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type
number

getItem(index) Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Name Type
index number

Returns

Type
BootstrapListBoxItem
null

getItemBadgeIconCssClass(index) Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Name Type
index number

Returns

Type
string

getItemBadgeText(index) Method

Declaration

getItemBadgeText(index: number): string

Parameters

Name Type
index number

Returns

Type
string

getItemCount Method

Declaration

getItemCount(): number

Returns

Type
number

getTagCollection Method

Declaration

getTagCollection(): string[]

Returns

Type
string[]

getTagHtmlElement(index) Method

Declaration

getTagHtmlElement(index: number): any

Parameters

Name Type
index number

Returns

Type
any

getTagIndexByText(text) Method

Declaration

getTagIndexByText(text: string): number

Parameters

Name Type
text string

Returns

Type
number

getTagRemoveButtonHtmlElement(index) Method

Declaration

getTagRemoveButtonHtmlElement(index: number): any

Parameters

Name Type
index number

Returns

Type
any

getTagTextHtmlElement(index) Method

Declaration

getTagTextHtmlElement(index: number): any

Parameters

Name Type
index number

Returns

Type
any

getText Method

Declaration

getText(): string

Returns

Type
string

getValue Method

Declaration

getValue(): string

Returns

Type
string

hideDropDown Method

Declaration

hideDropDown(): void

insertItem(index, text) Method

Declaration

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

Parameters

Name Type
index number
text string

insertItem(index, text, value) Method

Declaration

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

Parameters

Name Type
index number
text string
value any

insertItem(index, text, value, iconCssClass) Method

Declaration

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

Declaration

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

Parameters

Name Type
index number
texts string[]

insertItem(index, texts, value) Method

Declaration

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

Parameters

Name Type
index number
texts string[]
value any

insertItem(index, texts, value, iconCssClass) Method

Declaration

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

Parameters

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

isCustomTag(text, caseSensitive) Method

Declaration

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

Parameters

Name Type
text string
caseSensitive boolean

Returns

Type
boolean

makeItemVisible(index) Method

Declaration

makeItemVisible(index: number): void

Parameters

Name Type
index number

off<K> Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

performCallback(data) Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Name Type
data any

Returns

Type
Promise<void>

performCallback(data, onSuccess) Method

Declaration

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

Parameters

Name Type
data any
onSuccess () => void

removeItem(index) Method

Declaration

removeItem(index: number): void

Parameters

Name Type
index number

removeItemCssClass(index, className) Method

Declaration

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

Parameters

Name Type
index number
className string

removeItemTextCellCssClass(itemIndex, textCellIndex, className) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
className string

removeTag(index) Method

Declaration

removeTag(index: number): void

Parameters

Name Type
index number

removeTagByText(text) Method

Declaration

removeTagByText(text: string): void

Parameters

Name Type
text string

selectAll Method

Declaration

selectAll(): void

setButtonVisible(number, value) Method

Declaration

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

Parameters

Name Type
number number
value boolean

setCaretPosition(position) Method

Declaration

setCaretPosition(position: number): void

Parameters

Name Type
position number

setItemBadgeIconCssClass(index, cssClass) Method

Declaration

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

Parameters

Name Type
index number
cssClass string

setItemBadgeText(index, text) Method

Declaration

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

Parameters

Name Type
index number
text string

setItemHtml(index, html) Method

Declaration

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

Parameters

Name Type
index number
html string

setItemTextCellHtml(itemIndex, textCellIndex, html) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
html string

setItemTextCellTooltip(itemIndex, textCellIndex, tooltip) Method

Declaration

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

Parameters

Name Type
itemIndex number
textCellIndex number
tooltip string

setItemTooltip(index, tooltip) Method

Declaration

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

Parameters

Name Type
index number
tooltip string

setSelection(startPos, endPos, scrollToSelection) Method

Declaration

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

Parameters

Name Type
startPos number
endPos number
scrollToSelection boolean

setTagCollection(collection) Method

Declaration

setTagCollection(collection: string[]): void

Parameters

Name Type
collection string[]

setText(text) Method

Declaration

setText(text: string): void

Parameters

Name Type
text string

setValue(value) Method

Declaration

setValue(value: string): void

Parameters

Name Type
value string

showDropDown Method

Declaration

showDropDown(): void