ProgressBarControl.PerformStep() Method
Changes the progress bar’s position by the RepositoryItemProgressBar.Step property value.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v19.1.dll
Declaration
Remarks
If the control’s value exceeds its maximum value after the PerformStep method call, the control’s value is automatically set to its maximum value represented by the RepositoryItemProgressBar.Maximum property. Alternatively, if the control’s value is less than its minimum value, it is automatically set to its minimum value represented by the RepositoryItemProgressBar.Minimum property. The latter takes place when the RepositoryItemProgressBar.Step property value is negative.
You can also use the ProgressBarControl.Increment and ProgressBarControl.Decrement methods to correspondingly increase and decrease the progress bar’s position by the specified value.
Example
In the code fragment below, a DeleteFiles method removes all files contained within the directory specified by the source parameter. The ProgressBarControl is used to display the progress of file delete operations. The RepositoryItemProgressBar.Minimum and RepositoryItemProgressBar.Maximum properties are used to specify a range for the progress bar that is equivalent to the number of files to be removed. The code also uses the RepositoryItemProgressBar.Step property with the ProgressBarControl.PerformStep method, to increment the position of the progress bar as soon as a file is removed.
using System.IO;
using DevExpress.XtraEditors.Controls;
// ...
private void DeleteFiles(string source){
if (Directory.Exists(source)){
string[] fileEntries = Directory.GetFiles(source);
// Initializing progress bar properties
progressBarControl1.Properties.Step = 1;
progressBarControl1.Properties.PercentView = true;
progressBarControl1.Properties.Maximum = fileEntries.Length;
progressBarControl1.Properties.Minimum = 0;
// Removing the list of files found in the specified directory
foreach(string fileName in fileEntries){
File.Delete(fileName);
progressBarControl1.PerformStep();
progressBarControl1.Update();
}
}
}
// ...
DeleteFiles("d:\\Temp");
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PerformStep() method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.