BootstrapCheckBox Class

Declaration

class BootstrapCheckBox 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

getChecked Method

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

Declaration

getChecked(): boolean

Returns

Type
boolean

getCheckState Method

Returns a value which specifies a check box checked state.

Declaration

getCheckState(): string

Returns

Type
string

getText Method

Returns the text displayed within the editor.

Declaration

getText(): string

Returns

Type
string

off<K> Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

setChecked(isChecked) Method

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

Declaration

setChecked(isChecked: boolean): void

Parameters

Name Type
isChecked boolean

setCheckState(checkState) Method

Sets a value specifying the state of a check box.

Declaration

setCheckState(checkState: string): void

Parameters

Name Type
checkState string

setText(text) Method

Sets the text to be displayed within the editor.

Declaration

setText(text: string): void

Parameters

Name Type
text string