ProgressBarControl.PerformStep() Method
Changes the progress bar’s position by the RepositoryItemProgressBar.Step property value.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v19.2.dll
Declaration
Remarks
The PerformStep method increments the control’s value (ProgressBarControl.Position) by the RepositoryItemProgressBar.Step property value.
You can also change the control’s value using one of the following approaches:
- Set the ProgressBarControl.Position property.
- Call the ProgressBarControl.Increment and/or ProgressBarControl.Decrement methods.
The control’s value cannot exceed the range specified by the RepositoryItemProgressBar.Minimum and RepositoryItemProgressBar.Maximum values.
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.