RepositoryItemProgressBar.Step Property

Gets or sets a value by which a call to the ProgressBarControl.PerformStep method increases the control's current position.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

[DXCategory("Behavior")]
[DefaultValue(10)]
public int Step { get; set; }
<DXCategory("Behavior")>
<DefaultValue(10)>
Public Property Step As Integer

Property Value

Type Default Description
Int32

10

An integer value by which the progress bar's position changes.

Remarks

The Step property represents a value by which the ProgressBarControl.PerformStep method changes the progress bar's position (the ProgressBarControl.Position property).

For example, if you are copying a group of files, you may want to set the value of the Step property to 1 and the value of the RepositoryItemProgressBar.Maximum property to the total number of files to copy. When each file is copied, you can call the ProgressBarControl.PerformStep method to increment the progress bar's position by the Step property value.

If you need increase/decrease the progress bar's position by a value other than the Step value, use the ProgressBarControl.Increment and ProgressBarControl.Decrement methods respectively.

Examples

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");
See Also