BootstrapCheckBox Class

Declaration

export class BootstrapCheckBox extends BootstrapClientEdit

Inheritance

Methods

getCheckState method

Returns a value which specifies a check box checked state.

Declaration

getCheckState(): string

Returns

Type Description
string

getChecked method

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

Declaration

getChecked(): boolean

Returns

Type Description
boolean

getText method

Returns the text displayed within the editor.

Declaration

getText(): string

Returns

Type Description
string

off method

Declaration

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

Parameters

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

Returns

Type Description
this

on method

Declaration

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

Parameters

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

Returns

Type Description
this

once method

Declaration

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

Parameters

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

Returns

Type Description
this

setCheckState method

Sets a value specifying the state of a check box.

Declaration

setCheckState(checkState: string): void

Parameters

Type Name Description
string 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
boolean isChecked

setText method

Sets the text to be displayed within the editor.

Declaration

setText(text: string): void

Parameters

Type Name Description
string text