NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

NumericUpDown.Value

Gets or sets the value assigned to the up-down control.

[Visual Basic]
Public Property Value As Decimal
[C#]
public Decimal Value {get; set;}
[C++]
public: __property Decimal get_Value();
public: __property void set_Value(Decimal);
[JScript]
public function get Value() : Decimal;
public function set Value(Decimal);

Property Value

The numeric value of the NumericUpDown control.

Exceptions

Exception Type Condition
ArgumentException The up-down control is not being initialized and the assigned value is less than the Minimum property value.

-or-

The up-down control is not being initialized and the assigned value is greater than the Maximum property value.

Remarks

When the Value property is set, the new value is validated to be between the Minimum and Maximum values. Following this, the UpdateEditText method is called to update the up-down control's display with the new value in the appropriate format.

Example [Visual Basic]

The following example instantiates and initializes a NumericUpDown control, sets some of its common properties and allows the user to change some of these properties at run time. This code assumes three CheckBox controls have been placed on a form and handlers for their OnClick events have been instantiated. On the OnClick event of each check box, the DecimalPlaces, ThousandsSeparator and Hexadecimal properties are set, respectively.

[Visual Basic]

' Instantiate a NumericUpDown control.
Private NumericUpDown1 As System.WinForms.NumericUpDown

Public Sub MySub()
   ' Initialize the NumericUpDown control.
   NumericUpDown1 = New System.WinForms.NumericUpDown
   Form1.Controls.Add(NumericUpDown1)

   NumericUpDown1.BeginInit

      ' Dock the control to the top of the form.
      NumericUpDown1.Dock = System.WinForms.DockStyle.Top

      ' Set the Minimum, Maximum and the initial Value.
      NumericUpDown1.Value = 5
      NumericUpDown1.Maximum = 2500
      NumericUpDown1.Minimum = -100

   NumericUpDown1.EndInit
  
End Sub

' Check box to toggle decimal places to be displayed.
Private Sub CheckBox1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs)

   ' If DecimalPlaces is greater than 0, set them to 0 and round the current 
   ' Value; otherwise, set DecimalPlaces to 2 and change the Increment to 0.25.
   If NumericUpDown1.DecimalPlaces > 0 Then
      NumericUpDown1.DecimalPlaces = 0
      NumericUpDown1.Value = Round(NumericUpDown1.Value, 0)
   Else
      NumericUpDown1.DecimalPlaces = 2
      NumericUpDown1.Increment = 0.25
   End If

End Sub

' Check box to toggle thousands separators to be displayed.
Private Sub CheckBox2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs)
   
   ' If ThousandsSeparator is true, set it to False; otherwise se it to true.
   If NumericUpDown1.ThousandsSeparator = True Then
      NumericUpDown1.ThousandsSeparator = False
   Else
      NumericUpDown1.ThousandsSeparator = True
   End If

End Sub

' Check box to toggle hexadecimal to be displayed.
Private Sub CheckBox3_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs)

   ' If Hexadecimal is true, set it to False; otherwise se it to true.    
   If NumericUpDown1.Hexadecimal = True Then
      NumericUpDown1.Hexadecimal = False
   Else
      NumericUpDown1.Hexadecimal = True
   End If

End Sub

See Also

NumericUpDown Class | NumericUpDown Members | System.WinForms Namespace | Maximum | Minimum | UpdateEditText