BootstrapCheckBoxList Class

Declaration

export class BootstrapCheckBoxList extends BootstrapListBox

Inheritance

BootstrapListBox
BootstrapCheckBoxList

Properties

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

addItem Method

Declaration

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

Parameters

Type Name Description
string text
any value
string iconCssClass

Returns

Type Description
number

addItem Method

Declaration

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

Parameters

Type Name Description
string[] texts
any value

Returns

Type Description
number

addItem Method

Declaration

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

Parameters

Type Name Description
string text
any value

Returns

Type Description
number

addItem Method

Declaration

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

Parameters

Type Name Description
string[] texts
any value
string iconCssClass

Returns

Type Description
number

addItem Method

Declaration

addItem(text: string): number

Parameters

Type Name Description
string text

Returns

Type Description
number

addItem Method

Declaration

addItem(texts: string[]): number

Parameters

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

adjustControl Method

Declaration

adjustControl(): void

beginUpdate Method

Declaration

beginUpdate(): void

clearItems Method

Declaration

clearItems(): void

endUpdate Method

Declaration

endUpdate(): void

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

focus Method

Declaration

focus(): void

getCaption Method

Declaration

getCaption(): string

Returns

Type Description
string

getEnabled Method

Declaration

getEnabled(): boolean

Returns

Type Description
boolean

getErrorText Method

Declaration

getErrorText(): string

Returns

Type Description
string

getHeight Method

Declaration

getHeight(): number

Returns

Type Description
number

getInputElement Method

Declaration

getInputElement(): any

Returns

Type Description
any

getIsValid Method

Declaration

getIsValid(): boolean

Returns

Type Description
boolean

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

getMainElement Method

Declaration

getMainElement(): any

Returns

Type Description
any

getParentControl Method

Declaration

getParentControl(): any

Returns

Type Description
any

getReadOnly Method

Declaration

getReadOnly(): boolean

Returns

Type Description
boolean

getSelectedIndex Method

Declaration

getSelectedIndex(): number

Returns

Type Description
number

getSelectedIndices Method

Declaration

getSelectedIndices(): array[number]

Returns

Type Description
number[]

getSelectedItem Method

Declaration

getSelectedItem(): BootstrapListBoxItem | null

Returns

Type Description
BootstrapListBoxItem
null

getSelectedItems Method

Declaration

getSelectedItems(): array[BootstrapListBoxItem]

Returns

Type Description
BootstrapListBoxItem[]

getSelectedValues Method

Declaration

getSelectedValues(): array[any]

Returns

Type Description
any[]

getValue Method

Declaration

getValue(): any

Returns

Type Description
any

getVisible Method

Declaration

getVisible(): boolean

Returns

Type Description
boolean

getWidth Method

Declaration

getWidth(): number

Returns

Type Description
number

inCallback Method

Declaration

inCallback(): boolean

Returns

Type Description
boolean

insertItem Method

Declaration

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

Parameters

Type Name Description
number index
string[] texts
any value

insertItem Method

Declaration

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

Parameters

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

insertItem Method

Declaration

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

Parameters

Type Name Description
number index
string text

insertItem Method

Declaration

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

Parameters

Type Name Description
number index
string[] texts

insertItem Method

Declaration

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

Parameters

Type Name Description
number index
string text
any value
string iconCssClass

insertItem Method

Declaration

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

Parameters

Type Name Description
number index
string text
any value

makeItemVisible Method

Declaration

makeItemVisible(index: number): void

Parameters

Type Name Description
number index

off Method

Declaration

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

Parameters

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

Returns

Type Description
this

on Method

Declaration

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

Parameters

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

Returns

Type Description
this

once Method

Declaration

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

Parameters

Type Name Description
K eventName
(this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[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>

performCallback Method

Declaration

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

Parameters

Type Name Description
any data
() => void onSuccess

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

selectAll Method

Declaration

selectAll(): void

selectIndices Method

Declaration

selectIndices(indices: number[]): void

Parameters

Type Name Description
number[] indices

selectItems Method

Declaration

selectItems(items: BootstrapListBoxItem[]): void

Parameters

Type Name Description
BootstrapListBoxItem[] items

selectValues Method

Declaration

selectValues(values: any[]): void

Parameters

Type Name Description
any[] values

sendMessageToAssistiveTechnology Method

Declaration

sendMessageToAssistiveTechnology(message: string): void

Parameters

Type Name Description
string message

setCaption Method

Declaration

setCaption(caption: string): void

Parameters

Type Name Description
string caption

setEnabled Method

Declaration

setEnabled(value: boolean): void

Parameters

Type Name Description
boolean value

setErrorText Method

Declaration

setErrorText(errorText: string): void

Parameters

Type Name Description
string errorText

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
number height

setIsValid Method

Declaration

setIsValid(isValid: boolean): void

Parameters

Type Name Description
boolean isValid

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

setReadOnly Method

Declaration

setReadOnly(readOnly: boolean): void

Parameters

Type Name Description
boolean readOnly

setSelectedIndex Method

Declaration

setSelectedIndex(index: number): void

Parameters

Type Name Description
number index

setSelectedItem Method

Declaration

setSelectedItem(item: BootstrapListBoxItem): void

Parameters

Type Name Description
BootstrapListBoxItem item

setValue Method

Declaration

setValue(value: any): void

Parameters

Type Name Description
any value

setVisible Method

Declaration

setVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setWidth Method

Declaration

setWidth(width: number): void

Parameters

Type Name Description
number width

unselectAll Method

Declaration

unselectAll(): void

unselectIndices Method

Declaration

unselectIndices(indices: number[]): void

Parameters

Type Name Description
number[] indices

unselectItems Method

Declaration

unselectItems(items: BootstrapListBoxItem[]): void

Parameters

Type Name Description
BootstrapListBoxItem[] items

unselectValues Method

Declaration

unselectValues(values: any[]): void

Parameters

Type Name Description
any[] values

validate Method

Declaration

validate(): void