This documentation is archived and is not being maintained.

NumericUpDown.Value Property

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 assigned value is less than the Minimum property value.

-or-

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

The following example creates 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 Click events have been instantiated. The DecimalPlaces, ThousandsSeparator and Hexadecimal properties are set on the Click event of each check box.

[Visual Basic] 
Public Sub InstantiateMyNumericUpDown()
    ' Create and initialize a NumericUpDown control.
    numericUpDown1 = New NumericUpDown()
    
    ' Dock the control to the top of the form.
    numericUpDown1.Dock = System.Windows.Forms.DockStyle.Top
    
    ' Set the Minimum, Maximum, and initial Value.
    numericUpDown1.Value = 5
    numericUpDown1.Maximum = 2500
    numericUpDown1.Minimum = - 100
    
    ' Add the NumericUpDown to the Form.
    Controls.Add(numericUpDown1)
End Sub    

' Check box to toggle decimal places to be displayed.
Private Sub checkBox1_Click(sender As Object, e As 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 = Decimal.Round(numericUpDown1.Value, 0)
    Else
        numericUpDown1.DecimalPlaces = 2
        numericUpDown1.Increment = 0.25D
    End If
End Sub    

' Check box to toggle thousands separators to be displayed.
Private Sub checkBox2_Click(sender As Object, e As EventArgs)
    ' If ThousandsSeparator is true, set it to false;
    ' otherwise, set it to true. 
    If numericUpDown1.ThousandsSeparator Then
        numericUpDown1.ThousandsSeparator = False
    Else
        numericUpDown1.ThousandsSeparator = True
    End If
End Sub    

' Check box to toggle hexadecimal to be displayed.
Private Sub checkBox3_Click(sender As Object, e As EventArgs)
    ' If Hexadecimal is true, set it to false;
    ' otherwise, set it to true. 
    If numericUpDown1.Hexadecimal Then
        numericUpDown1.Hexadecimal = False
    Else
        numericUpDown1.Hexadecimal = True
    End If
End Sub


[C#] 
public void InstantiateMyNumericUpDown()
{
   // Create and initialize a NumericUpDown control.
   numericUpDown1 = new NumericUpDown();

   // Dock the control to the top of the form.
   numericUpDown1.Dock = System.Windows.Forms.DockStyle.Top;

   // Set the Minimum, Maximum, and initial Value.
   numericUpDown1.Value = 5;
   numericUpDown1.Maximum = 2500;
   numericUpDown1.Minimum = -100;
   
   // Add the NumericUpDown to the Form.
   Controls.Add(numericUpDown1);
}

// Check box to toggle decimal places to be displayed.
private void checkBox1_Click(Object sender,
                             EventArgs e)
{
   /* 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)
   {
      numericUpDown1.DecimalPlaces = 0;
      numericUpDown1.Value = Decimal.Round(numericUpDown1.Value, 0);
   }
   else
   {
      numericUpDown1.DecimalPlaces = 2;
      numericUpDown1.Increment = 0.25M;
   }
}

// Check box to toggle thousands separators to be displayed.
private void checkBox2_Click(Object sender,
                             EventArgs e)
{   
   /* If ThousandsSeparator is true, set it to false; 
      otherwise, set it to true. */
   if (numericUpDown1.ThousandsSeparator)
   {
      numericUpDown1.ThousandsSeparator = false;
   }
   else
   {
      numericUpDown1.ThousandsSeparator = true;
   }
}

// Check box to toggle hexadecimal to be displayed.
private void checkBox3_Click(Object sender, 
                             EventArgs e)
{
   /* If Hexadecimal is true, set it to false; 
      otherwise, set it to true. */    
   if (numericUpDown1.Hexadecimal)
   {
      numericUpDown1.Hexadecimal = false;
   }
   else
   {
      numericUpDown1.Hexadecimal = true;
   }
}


[C++] 
public:
    void InstantiateMyNumericUpDown() {
        // Create and initialize a NumericUpDown control.
        numericUpDown1 = new NumericUpDown();
 
        // Dock the control to the top of the form.
        numericUpDown1->Dock = System::Windows::Forms::DockStyle::Top;
     
        // Set the Minimum, Maximum, and initial Value.
        numericUpDown1->Value = 5;
        numericUpDown1->Maximum = 2500;
        numericUpDown1->Minimum = -100;
        
        // Add the NumericUpDown to the Form.
        Controls->Add(numericUpDown1);
    };
 
    // Check box to toggle decimal places to be displayed.
private:
    void checkBox1_Click(Object *sender, EventArgs *e) {
        /* 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) {
            numericUpDown1->DecimalPlaces = 0;
            numericUpDown1->Value = Decimal::Round(numericUpDown1->Value, 0);
        } else {
            numericUpDown1->DecimalPlaces = 2;
            numericUpDown1->Increment = 0.25;
        }
    };
 
    // Check box to toggle thousands separators to be displayed.
    void checkBox2_Click(Object *sender, EventArgs *e) {   
        /* If ThousandsSeparator is true, set it to false; 
        otherwise, set it to true. */
        if (numericUpDown1->ThousandsSeparator) {
            numericUpDown1->ThousandsSeparator = false;
        } else {
            numericUpDown1->ThousandsSeparator = true;
        }
    };
 
    // Check box to toggle hexadecimal to be displayed.
    void checkBox3_Click(Object *sender, EventArgs *e) {
        /* If Hexadecimal is true, set it to false; 
        otherwise, set it to true. */    
        if (numericUpDown1->Hexadecimal) {
            numericUpDown1->Hexadecimal = false;
        } else {
            numericUpDown1->Hexadecimal = true;
        }
    };
 

[JScript] 
function InstantiateMyNumericUpDown(){
  // Create and initialize a NumericUpDown control.
  numericUpDown1 = new NumericUpDown()
  
  // Dock the control to the top of the form.
  numericUpDown1.Dock = System.Windows.Forms.DockStyle.Top
  
  // Set the Minimum, Maximum, and initial Value.
  numericUpDown1.Value = 5
  numericUpDown1.Maximum = 2500
  numericUpDown1.Minimum = - 100
  
  // Add the NumericUpDown to the Form.
  Controls.Add(numericUpDown1)
}    

// Check box to toggle decimal places to be displayed.
function checkBox1_Click(sender : Object, e : 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){
    numericUpDown1.DecimalPlaces = 0
    numericUpDown1.Value = Decimal.Round(numericUpDown1.Value, 0)
  }else{
    numericUpDown1.DecimalPlaces = 2
    numericUpDown1.Increment = 0.25
  }
}    

// Check box to toggle thousands separators to be displayed.
function checkBox2_Click(sender : Object, e : EventArgs){
  // If ThousandsSeparator is true, set it to false;
  // otherwise, set it to true. 
  numericUpDown1.ThousandsSeparator = !numericUpDown1.ThousandsSeparator
}    

// Check box to toggle hexadecimal to be displayed.
function checkBox3_Click(sender : Object, e : EventArgs){
  // If Hexadecimal is true, set it to false;
  // otherwise, set it to true. 
  numericUpDown1.Hexadecimal = !numericUpDown1.Hexadecimal
}

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

NumericUpDown Class | NumericUpDown Members | System.Windows.Forms Namespace | Maximum | Minimum | UpdateEditText

Show: