JavaScript/jQuery NumberBox API
The NumberBox is a widget that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Configuration
Name | Description |
---|---|
accessKey |
Specifies the shortcut key that sets focus on the widget. |
activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
buttons |
Allows you to add custom buttons to the input text field. |
disabled |
Specifies whether the widget responds to user interaction. |
elementAttr |
Specifies the attributes to be attached to the widget's root element. |
focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
format |
Specifies the value's display format and controls user input accordingly. |
height |
Specifies the widget's height. |
hint |
Specifies text for a hint that appears when a user pauses on the widget. |
hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
inputAttr |
Specifies the attributes to be passed on to the underlying HTML element. |
invalidValueMessage |
Specifies the text of the message displayed if the specified value is not a number. |
isValid |
Specifies or indicates whether the editor's value is valid. |
max |
The maximum value accepted by the number box. |
min |
The minimum value accepted by the number box. |
mode |
Specifies the value to be passed to the type attribute of the underlying |
name |
The value to be assigned to the |
onChange |
A function that is executed when the widget loses focus after the text field's content was changed using the keyboard. |
onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
onCopy |
A function that is executed when the widget's input has been copied. |
onCut |
A function that is executed when the widget's input has been cut. |
onDisposing |
A function that is executed before the widget is disposed of. |
onEnterKey |
A function that is executed when the Enter key has been pressed while the widget is focused. |
onFocusIn |
A function that is executed when the widget gets focus. |
onFocusOut |
A function that is executed when the widget loses focus. |
onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
onInput |
A function that is executed each time the widget's input is changed while the widget is focused. |
onKeyDown |
A function that is executed when a user is pressing a key on the keyboard. |
onKeyPress |
A function that is executed when a user presses a key on the keyboard. |
onKeyUp |
A function that is executed when a user releases a key on the keyboard. |
onOptionChanged |
A function that is executed after a widget option is changed. |
onPaste |
A function that is executed when the widget's input has been pasted. |
onValueChanged |
A function that is executed after the widget's value is changed. |
placeholder |
The text displayed by the widget when the widget value is empty. |
readOnly |
Specifies whether the editor is read-only. |
rtlEnabled |
Switches the widget to a right-to-left representation. |
showClearButton |
Specifies whether to display the Clear button in the widget. |
showSpinButtons |
Specifies whether to show the buttons that change the value by a step. |
step |
Specifies how much the widget's value changes when using the spin buttons, Up/Down arrow keys, or mouse wheel. |
stylingMode |
Specifies how the widget's text field is styled. |
tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
text |
The read-only option that holds the text displayed by the widget input element. |
useLargeSpinButtons |
Specifies whether to use touch friendly spin buttons. Applies only if showSpinButtons is true. |
validationError |
Information on the broken validation rule. Contains the first item from the validationErrors array. |
validationErrors |
An array of the validation rules that failed. |
validationMessageMode |
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
validationStatus |
Indicates or specifies the current validation status. |
value |
The current number box value. |
valueChangeEvent |
Specifies the DOM events after which the widget's value should be updated. |
visible |
Specifies whether the widget is visible. |
width |
Specifies the widget's width. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
Name | Description |
---|---|
beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
blur() |
Removes focus from the input element. |
defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
dispose() |
Disposes of all the resources allocated to the NumberBox instance. |
element() |
Gets the root widget element. |
endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
focus() |
Sets focus to the input element representing the widget. |
getButton(name) |
Gets an instance of a custom action button. |
getInstance(element) |
Gets the instance of a widget found using its DOM node. |
instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
off(eventName) |
Detaches all event handlers from a single event. |
off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
on(eventName, eventHandler) |
Subscribes to an event. |
on(events) |
Subscribes to events. |
option() |
Gets all widget options. |
option(optionName) |
Gets the value of a single option. |
option(optionName, optionValue) |
Updates the value of a single option. |
option(options) |
Updates the values of several options. |
registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
reset() |
Resets the value option to null. |
resetOption(optionName) |
Resets an option to its default value. |
Events
Name | Description |
---|---|
change |
Raised when the widget loses focus after the text field's content was changed using the keyboard. |
contentReady |
Raised when the widget's content is ready. |
copy |
Raised when the widget's input has been copied. |
cut |
Raised when the widget's input has been cut. |
disposing |
Raised before the widget is disposed of. |
enterKey |
Raised when the Enter key has been pressed while the widget is focused. |
focusIn |
Raised when the widget gets focus. |
focusOut |
Raised when the widget loses focus. |
initialized |
Raised only once, after the widget is initialized. |
input |
Raised each time the widget's input is changed while the widget is focused. |
keyDown |
Raised when a user is pressing a key on the keyboard. |
keyPress |
Raised when a user presses a key on the keyboard. |
keyUp |
Raised when a user releases a key on the keyboard. |
optionChanged |
Raised after a widget option is changed. |
paste |
Raised when the widget's input has been pasted. |
valueChanged |
Raised after the widget's value is changed. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core