ASPxSpinEdit Overview
- 3 minutes to read
The ASPxSpinEdit control provides end-users with easy numeric value editing by incrementing and decrementing edit values, using spin buttons, a mouse wheel or keyboard.
ASPxSpinEdit offers the following features.
Customizable Button Visibility and Positions
The visibility of spin buttons is controlled by the SpinButtons.ShowIncrementButtons and SpinButtons.ShowLargeIncrementButtons properties. To define the position of a spin button within the editor, you can use the EditButton.Position property.
ASPxSpinEdit View
Affected Properties
ShowIncrementButtons = True
ShowLargeIncrementButtons = True
SpinButtons.Position = Left
ShowIncrementButtons = True
ShowLargeIncrementButtons = False
SpinButtons.Position = Right
ShowIncrementButtons = False
ShowLargeIncrementButtons = True
SpinButtons.Position = Right
Float or Integer Value Editing
ASPxSpinEdit supports the float and integer editing modes that is controlled by the ASPxSpinEdit.NumberType property. In an integer mode (when the NumberType property is set to Integer), float value input is disabled and float values displayed within the editor are automatically rounded after they have been modified. In a float mode, culture specific separators are supported, allowing decimal separators to display uniquely in various cultures. You can define the number of decimal places with the ASPxSpinEdit.DecimalPlaces property.
ASPxSpinEdit View
Affected Properties
NumberType = Integer
NumberType = Float
DecimalPlaces = 2
Increment = 10.253
Customizable Increment/Decrement Values
When an end-user presses a small or large spin button, the ASPxSpinEdit.Number property value is incremented or decremented by the amount specified via ASPxSpinEdit.Increment or ASPxSpinEdit.LargeIncrement properties respectively.
Customizable Minimum and Maximum Values
You can define the minimum and maximum allowed values via the ASPxSpinEdit.MinValue and ASPxSpinEdit.MaxValue properties; this enables end-user input to be limited by the specified range.
Out of Range Warning
If the ASPxSpinEdit.ShowOutOfRangeWarning property is set to true, the ASPxSpinEdit editor displays a warning message when an end-user types a date that is out of the range specified by the ASPxSpinEdit.MinValue and ASPxSpinEdit.MaxValue properties.
Mouse Wheel and Keyboard Support
End-users can change the ASPxSpinEdit value via a mouse wheel and keyboard (the ARROW UP and ARROW DOWN keys - for small increments/decrements; the CTRL+ARROW UP and CTRL+ARROW DOWN or PAGE UP and PAGE DOWN keys - for large increments/decrements).
Auto-Repeat Functionality
When end-users press and hold a spin button, it results in the continuous incrementing/decrementing of the editor value. The auto-repeat functionality is also available when end-users press the UP and DOWN keys to increment or decrement a value.
Full-Featured Client-Side API
ASPxSpinEdit provides you with a comprehensive client-side API. This API is implemented using JavaScript and is exposed via the ASPxClientSpinEdit object. The ASPxClientSpinEdit object serves as a client-side equivalent of the ASPxSpinEdit control.
You can operate with the editor values using the following methods.
Method Description ASPxClientSpinEdit.GetMaxValue Gets the maximum value of the editor. ASPxClientSpinEdit.GetMinValue Gets the minimum value of the editor. ASPxClientSpinEdit.GetNumber Gets a number which represents the spin editor’s value. ASPxClientSpinEdit.GetText Returns the text displayed within the editor. ASPxClientSpinEdit.SetMaxValue Sets the maximum value of the editor. ASPxClientSpinEdit.SetMinValue Sets the minimum value of the editor. ASPxClientSpinEdit.SetNumber Sets the spin editor’s value.