The requested page is not available for the requested platform. You are viewing the content for Default platform.

BootstrapTagBox Class

Declaration

export 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

BootstrapClientEdit
BootstrapTagBox

Methods

addItem Method

Declaration

addItem(texts: array[string]): number

Parameters

Name Type Description
texts

Returns

Type Description
number

addItemCssClass Method

Declaration

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

Parameters

Name Type Description
index
className

addItemTextCellCssClass Method

Declaration

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

Parameters

Name Type Description
itemIndex
textCellIndex
className

addTag Method

Declaration

addTag(text: string): void

Parameters

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

Name Type Description
callbackFunction

findItemByText Method

Declaration

findItemByText(text: string): BootstrapListBoxItem | null

Parameters

Name Type Description
text

Returns

Type Description
null
null

findItemByValue Method

Declaration

findItemByValue(value: any): BootstrapListBoxItem | null

Parameters

Name Type Description
value

Returns

Type Description
null
null

getButtonVisible Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Name Type Description
number

Returns

Type Description
boolean

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type Description
number

getItem Method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Name Type Description
index

Returns

Type Description
null
null

getItemBadgeIconCssClass Method

Declaration

getItemBadgeIconCssClass(index: number): string

Parameters

Name Type Description
index

Returns

Type Description
string

getItemBadgeText Method

Declaration

getItemBadgeText(index: number): string

Parameters

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

Name Type Description
index

Returns

Type Description
any

getTagIndexByText Method

Declaration

getTagIndexByText(text: string): number

Parameters

Name Type Description
text

Returns

Type Description
number

getTagRemoveButtonHtmlElement Method

Declaration

getTagRemoveButtonHtmlElement(index: number): any

Parameters

Name Type Description
index

Returns

Type Description
any

getTagTextHtmlElement Method

Declaration

getTagTextHtmlElement(index: number): any

Parameters

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

Name Type Description
index
texts

isCustomTag Method

Declaration

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

Parameters

Name Type Description
text
caseSensitive

Returns

Type Description
boolean

makeItemVisible Method

Declaration

makeItemVisible(index: number): void

Parameters

Name Type Description
index

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

performCallback Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Name Type Description
data

Returns

Type Description
Promise<void>

removeItem Method

Declaration

removeItem(index: number): void

Parameters

Name Type Description
index

removeItemCssClass Method

Declaration

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

Parameters

Name Type Description
index
className

removeItemTextCellCssClass Method

Declaration

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

Parameters

Name Type Description
itemIndex
textCellIndex
className

removeTag Method

Declaration

removeTag(index: number): void

Parameters

Name Type Description
index

removeTagByText Method

Declaration

removeTagByText(text: string): void

Parameters

Name Type Description
text

selectAll Method

Declaration

selectAll(): void

setButtonVisible Method

Declaration

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

Parameters

Name Type Description
number
value

setCaretPosition Method

Declaration

setCaretPosition(position: number): void

Parameters

Name Type Description
position

setItemBadgeIconCssClass Method

Declaration

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

Parameters

Name Type Description
index
cssClass

setItemBadgeText Method

Declaration

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

Parameters

Name Type Description
index
text

setItemHtml Method

Declaration

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

Parameters

Name Type Description
index
html

setItemTextCellHtml Method

Declaration

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

Parameters

Name Type Description
itemIndex
textCellIndex
html

setItemTextCellTooltip Method

Declaration

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

Parameters

Name Type Description
itemIndex
textCellIndex
tooltip

setItemTooltip Method

Declaration

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

Parameters

Name Type Description
index
tooltip

setSelection Method

Declaration

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

Parameters

Name Type Description
startPos
endPos
scrollToSelection

setTagCollection Method

Declaration

setTagCollection(collection: array[string]): void

Parameters

Name Type Description
collection

setText Method

Declaration

setText(text: string): void

Parameters

Name Type Description
text

setValue Method

Declaration

setValue(value: string): void

Parameters

Name Type Description
value

showDropDown Method

Declaration

showDropDown(): void