RepositoryItemProgressBar.Maximum Property
Gets or sets the control’s maximum value.
Namespace: DevExpress.XtraEditors.Repository
Assembly: DevExpress.XtraEditors.v20.2.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
Property Value
| Type | Default | Description |
|---|---|---|
| Int32 | 100 | An integer value representing the maximum value. |
Remarks
This property specifies the upper limit of the ProgressBarControl.Position property. When this value is modified, the control is redrawn immediately to reflect its new range of values.
Use this property to provide the value required for ProgressBarControl.Position to indicate that an operation is complete. For example, you can set the Maximum property to the total number of files in a file copy operation. Each time a file is copied, the ProgressBarControl.Position property can be increased by one until all files have been copied.
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 snippets (auto-collected from DevExpress Examples) contain references to the Maximum property.
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.