NumericUpDown

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • UpDownBase
    • NumericUpDown

Represents a spinner control that displays numeric values.

C#

public class NumericUpDown : UpDownBase, ISupportInitialize, INotifyPropertyChanged

VB.NET

Public Class NumericUpDown
    Inherits UpDownBase
    Implements ISupportInitialize, INotifyPropertyChanged

Constructors

NumericUpDown()

Initializes a new instance of the NumericUpDown class.

NumericUpDown(onValueChanged)

Initializes a new instance of the NumericUpDown class with specific initial settings.

Name	Type	Description
onValueChanged	Action<Object, EventArgs>	The delegate to invoke when the ValueChanged event is raised.

NumericUpDown(label, onValueChanged)

Initializes a new instance of the NumericUpDown class with specific initial settings.

Name	Type	Description
label	String	Initial LabelText value.
onValueChanged	Action<Object, EventArgs>	The delegate to invoke when the ValueChanged event is raised.

NumericUpDown(location, size, onValueChanged)

Initializes a new instance of the NumericUpDown class with specific initial settings.

Name	Type	Description
location	Point	The Point specifying the upper-left corner of the NumericUpDown control relative to the upper-left corner of its container.
size	Size	The Size of the NumericUpDown control.
onValueChanged	Action<Object, EventArgs>	The delegate to invoke when the ValueChanged event is raised.

NumericUpDown(label, location, size, onValueChanged)

Initializes a new instance of the NumericUpDown class with specific initial settings.

Name	Type	Description
label	String	Initial LabelText value.
location	Point	The Point specifying the upper-left corner of the NumericUpDown control relative to the upper-left corner of its container.
size	Size	The Size of the NumericUpDown control.
onValueChanged	Action<Object, EventArgs>	The delegate to invoke when the ValueChanged event is raised.

Properties

AllowEmptyText

Boolean: Gets or sets whether the control allows empty text. (Default: False)

DecimalPlaces

Int32: Returns or sets the number of decimal places to display in the spin box (also known as an up-down control). (Default: 0)

Throws:

• ArgumentOutOfRangeException The value assigned is less than 0; or the value assigned is greater than 99.

Hexadecimal

Boolean: Returns or sets whether the spin box (also known as an up-down control) should display the value it contains in hexadecimal format. (Default: False)

Increment

Decimal: Returns or sets the value to increment or decrement the spin box (also known as an up-down control) when the up or down buttons are clicked. (Default: 1)

Throws:

• ArgumentOutOfRangeException The assigned value is not greater than or equal to zero.

Maximum

Decimal: Returns or sets the maximum value for the spin box (also known as an up-down control). (Default: 100)

Minimum

Decimal: Returns or sets the minimum allowed value for the spin box (also known as an up-down control). (Default: 0)

NullableValue

Nullable<Decimal>: Returns or sets the Value assigned to the spin box (also known as an up-down control) with the difference that when the text is empty it returns null. (Default: 0)

This property should be used when the NumericUpDown may hold a null value and it's bound to a database nullable column. Throws:

• ArgumentOutOfRangeException The assigned value is less than the Minimum property value; or the assigned value is greater than the Maximum property value.

Postfix

String: Returns or sets a string to display after the value. (Default: "")

Prefix

String: Returns or sets a string to display before the value. (Default: "")

ThousandsSeparator

Boolean: Returns or sets whether a thousands separator is displayed in the spin box (also known as an up-down control) when appropriate. (Default: False)

Value

Decimal: Returns or sets the value assigned to the spin box (also known as an up-down control). (Default: 0)

Throws:

• ArgumentOutOfRangeException The assigned value is less than the Minimum property value; or the assigned value is greater than the Maximum property value.

Methods

OnLeave(e)

Fires the Leave event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnValidating(e)

Fires the Validating event.

Parameter	Type	Description
e	CancelEventArgs	A EventArgs that contains the event data.

OnValueChanged(e)

Fires the ValueChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

UpdateEditText()

Displays the current value of the spin box (also known as an up-down control) in the appropriate format.

ValidateEditText()

Validates and updates the text displayed in the spin box (also known as an up-down control).

Returns: Boolean. True if the text represents a valid value.

Events

ValueChanged

EventHandler Fired when the Value property has been changed in some way.

Inherited By

Name	Description
DataGridViewNumericUpDownEditingControl	Represents a NumericUpDown control that can be hosted in a DataGridViewNumericUpDownCell.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
ILabel	Provides access to the LabelWrapper associated with the controls that implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IValidation	Provides access to the validation events and properties property for controls that support validation.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.