RepositoryItemProgressBar.Minimum Property

Gets or sets the minimum value of the progress range.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(0)]
[DXCategory("Behavior")]
public int Minimum { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(0)>
Public Property Minimum As Integer

Property Value

Type	Default	Description
Int32	0	The minimum value.

Remarks

The Minimum property specifies the lowest possible value of the ProgressBarControl. The current progress value (ProgressBarControl.Position property) must be greater than or equal to Minimum.

progressBarControl.Properties.Minimum = 0;
progressBarControl.Properties.Maximum = 100;
progressBarControl.Position = 25;

Note

Setting the Minimum property to a value greater than the Maximum property, automatically sets Minimum to match Maximum. This ensures the progress range remains valid.

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.

C#

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

VB.NET

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")

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Minimum 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.

C#

winforms-scheduler-create-appointments-on-reminder-alert/CS/ReminderCustomActions/Form1.cs#L38

this.timer1.Interval = 1000;
this.progressBarControl1.Properties.Minimum = 0;
this.progressBarControl1.Properties.Maximum = timeBeforeAlert;

how-to-use-docvariable-fields/CS/DocumentVariablesExample/MyProgressIndicator.cs#L30

{
    _Indicator.Properties.Minimum = minProgress;
    _Indicator.Properties.Maximum = maxProgress;

VB.NET

winforms-scheduler-create-appointments-on-reminder-alert/VB/ReminderCustomActions/Form1.vb#L40

Me.timer1.Interval = 1000
Me.progressBarControl1.Properties.Minimum = 0
Me.progressBarControl1.Properties.Maximum = timeBeforeAlert

how-to-use-docvariable-fields/VB/DocumentVariablesExample/MyProgressIndicator.vb#L30

Private Sub Begin(ByVal displayName As String, ByVal minProgress As Integer, ByVal maxProgress As Integer, ByVal currentProgress As Integer) Implements IProgressIndicationService.Begin
    _Indicator.Properties.Minimum = minProgress
    _Indicator.Properties.Maximum = maxProgress