Export (0) Print
Expand All

ProgressBar.Value Property

Gets or sets the current position of the progress bar.

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

Property Value

The position within the range of the progress bar. The default is 0.

Exceptions

Exception Type Condition
ArgumentException The value specified is greater than the value of the Maximum property.

-or-

The value specified is less than the value of the Minimum property.

Remarks

The minimum and maximum values of the Value property are specified by the Minimum and Maximum properties. This property enables you to increment or decrement the value of the progress bar directly. To perform consistent increases in the value of the ProgressBar control you can use the Step property with the PerformStep method. To increase the progress bar value by varying amounts, use the Increment method.

Example

[Visual Basic, C#, C++] The following example demonstrates how to use the Increment method and the Value property to increment the value of a ProgressBar in the Tick event of a Timer. The example also displays the Value property in a StatusBarPanel object to provide a textual representation of the ProgressBar. This example assumes that you have a ProgressBar control, named progressBar1, and a StatusBar control that contains a StatusBarPanel, named statusBarPanel1. The Timer object, named time, must be added to the form as a member.

[Visual Basic] 
Private time As New Timer()

' Call this method from the constructor of the form.
Private Sub InitializeMyTimer()
   ' Set the interval for the timer.
   time.Interval = 250
   ' Connect the Tick event of the timer to its event handler.
   AddHandler time.Tick, AddressOf IncreaseProgressBar
   ' Start the timer.
   time.Start()
End Sub


Private Sub IncreaseProgressBar(ByVal sender As Object, ByVal e As EventArgs)
   ' Increment the value of the ProgressBar a value of one each time.
   ProgressBar1.Increment(1)
   ' Display the textual value of the ProgressBar in the StatusBar control's first panel.
   statusBarPanel1.Text = ProgressBar1.Value.ToString() + "% Completed"
   ' Determine if we have completed by comparing the value of the Value property to the Maximum value.
   If ProgressBar1.Value = ProgressBar1.Maximum Then
      ' Stop the timer.
      time.Stop()
   End If
End Sub

[C#] 
private Timer time = new Timer();

// Call this method from the constructor of the form.
private void InitializeMyTimer()
{
   // Set the interval for the timer.
   time.Interval = 250;
   // Connect the Tick event of the timer to its event handler.
   time.Tick += new EventHandler(IncreaseProgressBar);
   // Start the timer.
   time.Start();
}

private void IncreaseProgressBar(object sender, EventArgs e)
{
   // Increment the value of the ProgressBar a value of one each time.
   progressBar1.Increment(1);
   // Display the textual value of the ProgressBar in the StatusBar control's first panel.
   statusBarPanel1.Text = progressBar1.Value.ToString() + "% Completed";
   // Determine if we have completed by comparing the value of the Value property to the Maximum value.
   if (progressBar1.Value == progressBar1.Maximum)
      // Stop the timer.
      time.Stop();
}

[C++] 
private:
   Timer* time;

   // Call this method from the constructor of the form.
   void InitializeMyTimer()
   {
      // Set the interval for the timer.
      time->Interval = 250;
      // Connect the Tick event of the timer to its event handler.
      time->Tick += new EventHandler(this, &Form1::IncreaseProgressBar);
      // Start the timer.
      time->Start();
   }

   void IncreaseProgressBar(Object* /*sender*/, EventArgs* /*e*/)
   {
      // Increment the value of the ProgressBar a value of one each time.
      progressBar1->Increment(1);
      // Display the textual value of the ProgressBar in the StatusBar control's first panel.
      statusBarPanel1->Text = String::Concat( __box(progressBar1->Value), S"% Completed" );
      // Determine if we have completed by comparing the value of the Value property to the Maximum value.
      if (progressBar1->Value == progressBar1->Maximum)
         // Stop the timer.
         time->Stop();
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

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

ProgressBar Class | ProgressBar Members | System.Windows.Forms Namespace | Maximum | Minimum

Show:
© 2015 Microsoft