ToolStripProgressBar.PerformStep Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripProgressBar.cs

Advances the current position of the progress bar by the amount of the Step property.

public:
 void PerformStep();

public void PerformStep ();

member this.PerformStep : unit -> unit

Public Sub PerformStep ()

Remarks

The PerformStep method increments the value of the progress bar by the amount specified by the Step property. You can use the Step property to specify the amount that each completed task in an operation changes the value of the progress bar. For example, if you are copying a group of files, you might want to set the value of the Step property to 1 and the value of the Maximum property to the total number of files to copy. When each file is copied, you can call the PerformStep method to increment the progress bar by the value of the Step property. If you want to have more flexible control of the value of the progress bar, you can use the Increment method or set the value of the Value property directly.

The Value property specifies the current position of the ToolStripProgressBar. If, after calling the PerformStep method, the Value property is greater than the value of the Maximum property, the Value property remains at the value of the Maximum property. If, after calling the PerformStep method with a negative value specified in the value parameter, the Value property is less than the value of the Minimum property, the Value property remains at the value of the Minimum property.