BootstrapSpinEdit Class

Declaration

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

getButtonVisible(number) Method

Declaration

getButtonVisible(number: number): boolean

Parameters

Name Type
number number

Returns

Type
boolean

getCaretPosition Method

Declaration

getCaretPosition(): number

Returns

Type
number

getMaxValue Method

Gets the maximum value of the editor.

Declaration

getMaxValue(): number

Returns

Type Description
number

A number representing the maximum value of the editor.

getMinValue Method

Gets the minimum value of the editor.

Declaration

getMinValue(): number

Returns

Type Description
number

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
number

A number representing the value of the spin editor.

Remarks

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
string

A string value representing the text within the editor.

Remarks

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<K> Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

selectAll Method

Declaration

selectAll(): void

setButtonVisible(number, value) Method

Declaration

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

Parameters

Name Type
number number
value boolean

setCaretPosition(position) Method

Declaration

setCaretPosition(position: number): void

Parameters

Name Type
position number

setMaxValue(value) Method

Sets the maximum value of the editor.

Declaration

setMaxValue(value: number): void

Parameters

Name Type Description
value number

A number specifying the maximum value of the editor.

setMinValue(value) Method

Sets the minimum value of the editor.

Declaration

setMinValue(value: number): void

Parameters

Name Type Description
value number

A number specifying the minimum value of the editor.

setNumber(number) Method

Sets the spin editor's value.

Declaration

setNumber(number: number): void

Parameters

Name Type Description
number number

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

Remarks

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(startPos, endPos, scrollToSelection) Method

Declaration

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

Parameters

Name Type
startPos number
endPos number
scrollToSelection boolean

setText(text) Method

Returns the text displayed within the editor.

Declaration

setText(text: string): void

Parameters

Name Type Description
text string

A string value representing the text within the editor.

Remarks

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(number) Method

Declaration

setValue(number: number): void

Parameters

Name Type
number number