BootstrapCheckBox Class

Declaration

export class BootstrapCheckBox extends BootstrapClientEdit

Inheritance

BootstrapClientEdit
BootstrapCheckBox

Properties

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

adjustControl Method

Declaration

adjustControl(): void

focus Method

Declaration

focus(): void

getCaption Method

Declaration

getCaption(): string

Returns

Type Description
string

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

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

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

getText Method

Returns the text displayed within the editor.

Declaration

getText(): string

Returns

Type Description
string

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

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<K extends keyof BootstrapCheckBoxEventMap>(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<K extends keyof BootstrapCheckBoxEventMap>(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

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

setCheckState Method

Declaration

setCheckState(checkState: string): void

Parameters

Type Name Description
string checkState

setChecked Method

Declaration

setChecked(isChecked: boolean): void

Parameters

Type Name Description
boolean isChecked

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

setReadOnly Method

Declaration

setReadOnly(readOnly: boolean): void

Parameters

Type Name Description
boolean readOnly

setText Method

Declaration

setText(text: string): void

Parameters

Type Name Description
string text

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

validate Method

Declaration

validate(): void