Export (0) Print
Expand All

ProgressBar.Minimum Property

Gets or sets the minimum value of the range of the control.

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

Property Value

The minimum value of the range. The default is 0.

Exceptions

Exception Type Condition
ArgumentException The value specified for the property is less than zero.

Remarks

This property specifies the lower limit of the Value property. When the value of the Minimum property is changed, the ProgressBar control is redrawn to reflect the new range of the control. When the value of the Value property is equal to the value of the Minimum property, the progress bar is empty. To change the value of the progress bar, use the Step property with the PerformStep method, use the Increment method, or set the value of the Value property directly.

Example

[Visual Basic, C#, C++] The following example uses a ProgressBar control to display the progress of a file copy operation. The example uses the Minimum and Maximum properties to specify a range for the ProgressBar that is equivalent to the number of files to copy. The code also uses the Step property with the PerformStep method to increment the value of the ProgressBar as a file is copied. This example assumes that you have a ProgressBar control created called pBar1 that is created within a Form and that there is a method created called CopyFile (that returns a Boolean value indicating the file copy operation was completed successfully) that performs the file copy operation. The code also assumes that an array of strings containing the files to copy is created and passed to the CopyWithProgress method defined in the example and that the method is called from another method or event in the Form.

[Visual Basic] 
Private Sub CopyWithProgress(ByVal ParamArray filenames As String())
    ' Display the ProgressBar control.
    pBar1.Visible = True
    ' Set Minimum to 1 to represent the first file being copied.
    pBar1.Minimum = 1
    ' Set Maximum to the total number of files to copy.
    pBar1.Maximum = filenames.Length
    ' Set the initial value of the ProgressBar.
    pBar1.Value = 1
    ' Set the Step property to a value of 1 to represent each file being copied.
    pBar1.Step = 1

    ' Loop through all files to copy.
    Dim x As Integer
    for x = 1 To filenames.Length - 1
        ' Copy the file and increment the ProgressBar if successful.
        If CopyFile(filenames(x - 1)) = True Then
            ' Perform the increment on the ProgressBar.
            pBar1.PerformStep()
        End If
    Next x
End Sub

[C#] 
private void CopyWithProgress(string[] filenames)
{
    // Display the ProgressBar control.
    pBar1.Visible = true;
    // Set Minimum to 1 to represent the first file being copied.
    pBar1.Minimum = 1;
    // Set Maximum to the total number of files to copy.
    pBar1.Maximum = filenames.Length;
    // Set the initial value of the ProgressBar.
    pBar1.Value = 1;
    // Set the Step property to a value of 1 to represent each file being copied.
    pBar1.Step = 1;
    
    // Loop through all files to copy.
    for (int x = 1; x <= filenames.Length; x++)
    {
        // Copy the file and increment the ProgressBar if successful.
        if(CopyFile(filenames[x-1]) == true)
        {
            // Perform the increment on the ProgressBar.
            pBar1.PerformStep();
        }
    }
}

[C++] 
private:
   void CopyWithProgress(String* filenames[])
   {
      // Display the ProgressBar control.
      pBar1->Visible = true;
      // Set Minimum to 1 to represent the first file being copied.
      pBar1->Minimum = 1;
      // Set Maximum to the total number of files to copy.
      pBar1->Maximum = filenames->Length;
      // Set the initial value of the ProgressBar.
      pBar1->Value = 1;
      // Set the Step property to a value of 1 to represent each file being copied.
      pBar1->Step = 1;

      // Loop through all files to copy.
      for (int x = 1; x <= filenames->Length; x++)
      {
         // Copy the file and increment the ProgressBar if successful.
         if(CopyFile(filenames[x-1]) == true)
         {
            // Perform the increment on the ProgressBar.
            pBar1->PerformStep();
         }
      }
   }

[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 | Value

Show:
© 2014 Microsoft