BootstrapSpinEdit Class

Declaration

export class BootstrapSpinEdit extends BootstrapClientEdit

Inheritance

BootstrapClientEdit
BootstrapSpinEdit

Methods

getButtonVisible Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Type Name Description
number

Returns

Type Description

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type Description

getMaxValue Method

Gets the maximum value of the editor.

Declaration

getMaxValue(): number

Returns

Type Description

A number representing the maximum value of the editor.

getMinValue Method

Gets the minimum value of the editor.

Declaration

getMinValue(): number

Returns

Type Description

A number representing the minimum value of the editor.

getNumber Method

Gets a number which represents the spin editor's value

Declaration

getNumber(): number

Returns

Type Description

A number representing the value of the spin editor.

Use the getNumber method to obtain the spin editor's value in a decimal representation. The value edited by the spin editor can be accessed or changed via the GetValue or SetValue methods, respectively.

getText Method

Returns the text displayed within the editor.

Declaration

getText(): string

Returns

Type Description

A string value representing the text within the editor.

This method returns the editor's displayed text representing the editor's value formatted according to a display format pattern applied (if any) and information about a specific culture used.

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

selectAll Method

Declaration

selectAll(): void

setButtonVisible Method

Declaration

setButtonVisible(number: number, value: boolean): void

Parameters

Type Name Description
number
value

setCaretPosition Method

Declaration

setCaretPosition(position: number): void

Parameters

Type Name Description
position

setMaxValue Method

Sets the maximum value of the editor.

Declaration

setMaxValue(value: number): void

Parameters

Type Name Description
value

A number specifying the maximum value of the editor.

setMinValue Method

Sets the minimum value of the editor.

Declaration

setMinValue(value: number): void

Parameters

Type Name Description
value

A number specifying the minimum value of the editor.

setNumber Method

Sets the spin editor's value.

Declaration

setNumber(number: number): void

Parameters

Type Name Description
number

A number specifying the value to assign to the spin editor.

Use the setNumber method to specify the spin editor's value in a decimal representation. The value edited by the spin editor can be accessed or changed via the GetValue or SetValue methods, respectively.

setSelection Method

Declaration

setSelection(startPos: number, endPos: number, scrollToSelection: boolean): void

Parameters

Type Name Description
startPos
endPos
scrollToSelection

setText Method

Returns the text displayed within the editor.

Declaration

setText(text: string): void

Parameters

Type Name Description
text

A string value representing the text within the editor.

This method returns the editor's displayed text representing the editor's value formatted according to a display format pattern applied (if any) and information about a specific culture used.

setValue Method

Declaration

setValue(number: number): void

Parameters

Type Name Description
number