NumberBox
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.
You can create the widget using one of the following approaches.
jQuery
$(function () { $("#numberBox").dxNumberBox({ value: 20, min: 16, max: 100, placeholder: 'Enter your age' }); });
<div id="numberBox"></div>
Angular
<dx-number-box [value]="20" [min]="16" [max]="100" placeholder="Enter your age"> </dx-number-box>
AngularJS
<div dx-number-box="{ value: 20, min: 16, max: 100, placeholder: 'Enter your age' }"></div>
Knockout
<div data-bind="dxNumberBox: { value: 20, min: 16, max: 100, placeholder: 'Enter your age' }"></div>
ASP.NET MVC Controls
@(Html.DevExtreme().NumberBox() .ID("numberBox") .Value(20) .Min(16) .Max(100) .Placeholder("Enter your age") )
@(Html.DevExtreme().NumberBox() _ .ID("numberBox") _ .Value(20) _ .Min(16) _ .Max(100) _ .Placeholder("Enter your age") )
Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.
See Also
Configuration
An object defining configuration options for the NumberBox widget.
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. |
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. |
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 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 handler for the change event. |
onContentReady | A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes. |
onCopy | A handler for the copy event. |
onCut | A handler for the cut event. |
onDisposing | A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
onEnterKey | A handler for the enterKey event. |
onFocusIn | A handler for the focusIn event. |
onFocusOut | A handler for the focusOut event. |
onInitialized | A handler for the initialized event. Executed only once, after the widget is initialized. |
onInput | A handler for the input event. |
onKeyDown | A handler for the keyDown event. |
onKeyPress | A handler for the keyPress event. |
onKeyUp | A handler for the keyUp event. |
onOptionChanged | A handler for the optionChanged event. Executed after an option of the widget is changed. |
onPaste | A handler for the paste event. |
onValueChanged | A handler for the valueChanged event. |
placeholder | The text displayed by the widget when the widget value is empty. |
readOnly | A Boolean value specifying whether or not the widget 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 by which value the widget value changes when a spin button is clicked. |
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 | Holds the object that defines the error that occurred during validation. |
validationMessageMode | Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
value | The current number box value. |
valueChangeEvent | Specifies DOM event names that update a widget's value. |
visible | Specifies whether the widget is visible. |
width | Specifies the widget's width. |
Methods
This section describes the members used to manipulate the widget.
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. |
element() | Gets the root element of the widget. |
endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
focus() | Sets focus to the input element representing the widget. |
instance() | Returns this widget's instance. Use it to access other methods of the widget. |
off(eventName) | Detaches all event handlers from the specified event. |
off(eventName, eventHandler) | Detaches a particular event handler from the specified event. |
on(eventName, eventHandler) | Subscribes to a specified event. |
on(events) | Subscribes to the specified events. |
option() | Gets the widget's options. |
option(optionName) | Gets a specific option value. |
option(optionName, optionValue) | Assigns a new value to a specific option. |
option(options) | Sets one or more options. |
registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
repaint() | Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
reset() | Resets the value option to an empty string. |
Events
This section describes events fired by this widget.
Name | Description |
---|---|
change | Fires when a change within the widget's input element is committed by an end user. |
contentReady | Raised when the widget's content is ready. |
copy | Fires after the widget's input has been copied. |
cut | Fires after the Cut DOM event has fired. |
disposing | Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
enterKey | Fires after the Enter key has been pressed within the widget's input element. |
focusIn | Fires after the widget's input has been focused. |
focusOut | Fires after the widget's input element has lost focus. |
initialized | Raised only once, after the widget is initialized. |
input | Fires when a value within the widget's input element is changed by an end user. |
keyDown | Fires when a key is pressed down within the widget's input element. |
keyPress | Fires when the keypress DOM event has been raised for the current input element. |
keyUp | Fires when a key is released within the widget's input element. |
optionChanged | Raised after an option of the widget is changed. |
paste | Fires after the widget's input has been pasted. |
valueChanged | Fires when the editor value changes. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.