Skip to main content

BootstrapTagBox Class

In This Article
Methods

#Declaration

TypeScript
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

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

#addTag(text) Method

#Declaration

TypeScript
addTag(
    text: string
): void

#Parameters

Name Type
text string

#adjustDropDownWindow Method

#Declaration

TypeScript
adjustDropDownWindow(): void

#beginUpdate Method

#Declaration

TypeScript
beginUpdate(): void

#clearItems Method

#Declaration

TypeScript
clearItems(): void

#clearTagCollection Method

#Declaration

TypeScript
clearTagCollection(): void

#endUpdate Method

#Declaration

TypeScript
endUpdate(): void

#ensureDropDownLoaded(callbackFunction) Method

#Declaration

TypeScript
ensureDropDownLoaded(
    callbackFunction: any
): void

#Parameters

Name Type
callbackFunction any

#findItemByText(text) Method

#Declaration

TypeScript
findItemByText(
    text: string
): BootstrapListBoxItem | null

#Parameters

Name Type
text string

#Returns

Type
BootstrapListBoxItem
null

#findItemByValue(value) Method

#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

#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

#Declaration

TypeScript
getItemCount(): number

#Returns

Type
number

#getTagCollection Method

#Declaration

TypeScript
getTagCollection(): string[]

#Returns

Type
string[]

#getTagHtmlElement(index) Method

#Declaration

TypeScript
getTagHtmlElement(
    index: number
): any

#Parameters

Name Type
index number

#Returns

Type
any

#getTagIndexByText(text) Method

#Declaration

TypeScript
getTagIndexByText(
    text: string
): number

#Parameters

Name Type
text string

#Returns

Type
number

#getTagRemoveButtonHtmlElement(index) Method

#Declaration

TypeScript
getTagRemoveButtonHtmlElement(
    index: number
): any

#Parameters

Name Type
index number

#Returns

Type
any

#getTagTextHtmlElement(index) Method

#Declaration

TypeScript
getTagTextHtmlElement(
    index: number
): any

#Parameters

Name Type
index number

#Returns

Type
any

#getText Method

#Declaration

TypeScript
getText(): string

#Returns

Type
string

#getValue Method

#Declaration

TypeScript
getValue(): 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

#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

#isCustomTag(text, caseSensitive) Method

#Declaration

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

#Parameters

Name Type
text string
caseSensitive boolean

#Returns

Type
boolean

#makeItemVisible(index) Method

#Declaration

TypeScript
makeItemVisible(
    index: number
): void

#Parameters

Name Type
index number

#off<K> Method

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

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

#Parameters

Name Type
data any

#Returns

Type
Promise<void>

#performCallback(data, onSuccess) Method

#Declaration

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

#Parameters

Name Type
data any
onSuccess () => void

#removeItem(index) Method

#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

#removeTag(index) Method

#Declaration

TypeScript
removeTag(
    index: number
): void

#Parameters

Name Type
index number

#removeTagByText(text) Method

#Declaration

TypeScript
removeTagByText(
    text: string
): void

#Parameters

Name Type
text 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

#setSelection(startPos, endPos, scrollToSelection) Method

#Declaration

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

#Parameters

Name Type
startPos number
endPos number
scrollToSelection boolean

#setTagCollection(collection) Method

#Declaration

TypeScript
setTagCollection(
    collection: string[]
): void

#Parameters

Name Type
collection string[]

#setText(text) Method

#Declaration

TypeScript
setText(
    text: string
): void

#Parameters

Name Type
text string

#setValue(value) Method

#Declaration

TypeScript
setValue(
    value: string
): void

#Parameters

Name Type
value string

#showDropDown Method

#Declaration

TypeScript
showDropDown(): void