BootstrapCheckBox Class

Declaration

export class BootstrapCheckBox extends BootstrapClientEdit

Inheritance

BootstrapClientEdit
BootstrapCheckBox

Methods

getCheckState Method

Returns a value which specifies a check box checked state.

Declaration

getCheckState(): string

Returns

Type Description

getChecked Method

Returns a value indicating whether the check box editor is checked.

Declaration

getChecked(): boolean

Returns

Type Description

getText Method

Returns the text displayed within the editor.

Declaration

getText(): string

Returns

Type Description

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

setCheckState Method

Sets a value specifying the state of a check box.

Declaration

setCheckState(checkState: string): void

Parameters

Type Name Description
checkState

setChecked Method

Sets a value which specifies the checked status of the check box editor.

Declaration

setChecked(isChecked: boolean): void

Parameters

Type Name Description
isChecked

setText Method

Sets the text to be displayed within the editor.

Declaration

setText(text: string): void

Parameters

Type Name Description
text