windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitemprogressbar-5f06a5c2.md
Gets or sets the maximum value of the progress range.
Namespace : DevExpress.XtraEditors.Repository
Assembly : DevExpress.XtraEditors.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
[DefaultValue(100)]
[DXCategory("Behavior")]
public int Maximum { get; set; }
<DXCategory("Behavior")>
<DefaultValue(100)>
Public Property Maximum As Integer
| Type | Default | Description |
|---|---|---|
| Int32 | 100 |
The maximum value.
|
The Maximum property specifies the highest possible value of the ProgressBarControl. The current progress value (ProgressBarControl.Position property) must be less than or equal to Maximum.
progressBarControl.Properties.Minimum = 0;
progressBarControl.Properties.Maximum = 100;
progressBarControl.Position = 25;
Note
Setting the Maximum property to a value less than the Minimum property, automatically sets Maximum to match Minimum. This ensures the progress range remains valid.
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");
Imports System.IO
Imports DevExpress.XtraEditors.Controls
' ...
Private Sub DeleteFiles(ByVal source As String)
If Directory.Exists(source) Then
Dim fileEntries As String() = 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
For Each fileName As String In fileEntries
File.Delete(fileName)
progressBarControl1.PerformStep()
progressBarControl1.Update()
Next fileName
End If
End Sub
' ...
DeleteFiles("d:\Temp")
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.
winforms-scheduler-create-appointments-on-reminder-alert/CS/ReminderCustomActions/Form1.cs#L39
this.progressBarControl1.Properties.Minimum = 0;
this.progressBarControl1.Properties.Maximum = timeBeforeAlert;
this.progressBarControl1.Position = timeBeforeAlert;
how-to-use-docvariable-fields/CS/DocumentVariablesExample/MyProgressIndicator.cs#L31
_Indicator.Properties.Minimum = minProgress;
_Indicator.Properties.Maximum = maxProgress;
_Indicator.Properties.ShowTitle = true;
winforms-scheduler-create-appointments-on-reminder-alert/VB/ReminderCustomActions/Form1.vb#L41
Me.progressBarControl1.Properties.Minimum = 0
Me.progressBarControl1.Properties.Maximum = timeBeforeAlert
Me.progressBarControl1.Position = timeBeforeAlert
how-to-use-docvariable-fields/VB/DocumentVariablesExample/MyProgressIndicator.vb#L31
_Indicator.Properties.Minimum = minProgress
_Indicator.Properties.Maximum = maxProgress
_Indicator.Properties.ShowTitle = True
See Also
RepositoryItemProgressBar Class