ProgressBarControl.EditValue Property

Gets or sets the value representing the progress bar’s current position.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
[DefaultValue(0)]
public override object EditValue { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(0)>
Public Overrides Property EditValue As Object

Property Value

Type	Default	Description
Object	0	An object value representing the progress bar’s current position.

Remarks

This property overrides the base class property in order to represent the progress bar’s current position.

You can assign any object to the EditValue property. The specified object should be convertible to an integer value (e.g., it should implement the IConvertible interface). If the specified object cannot be converted to an integer value, the RepositoryItemProgressBar.Minimum value is assigned. If the specified value oversteps the RepositoryItemProgressBar.Minimum or RepositoryItemProgressBar.Maximum value, the corresponding extreme value is assigned.

Changing this property value at runtime raises the RepositoryItem.EditValueChanging and RepositoryItem.EditValueChanged events.

You can also change the progress bar’s current position using the ProgressBarControl.Position property, which is sync with the EditValue property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EditValue 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-mvvm-best-practices/CS/POCOAsynchronousCommands/SimpleCommandWithCancellationUserControl.cs#L40

// UI binding for progress
mvvmContext.SetBinding(progressBar, p => p.EditValue, "Progress");
#endregion #simpleCommandWithCancellation

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

_Indicator.Properties.ShowTitle = true;
_Indicator.EditValue = currentProgress;
_Indicator.Refresh();

winforms-progressbar-update-from-separate-thread/CS/Busy/ProgressControl.cs#L30

private void UpdateProgressBar(int value) {
   progressBarControl1.EditValue = value;
}

winforms-grid-display-colored-progress-bars/CS/ColoredProgressBar/SingleRepositoryProgressBar.cs#L23

ProgressBarControl pbc = _View.ActiveEditor as ProgressBarControl;
int percent = Convert.ToInt16(pbc.EditValue);
if (percent < 25) {

XPO_how-to-bind-data-to-winforms-controls-using-xpservermodeview-or-xpinstantfeedbackview/CS/XPServerModeViewDemo/ProgressForm.cs#L19

public void Report(int value) {
    progressBarControl1.EditValue = value;
}

VB.NET

winforms-mvvm-best-practices/VB/POCOAsynchronousCommands/SimpleCommandWithCancellationUserControl.vb#L38

    ' UI binding for progress
    mvvmContext.SetBinding(progressBar, Function(p) p.EditValue, "Progress")
End Sub

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

_Indicator.Properties.ShowTitle = True
_Indicator.EditValue = currentProgress
_Indicator.Refresh()

winforms-progressbar-update-from-separate-thread/VB/Busy/ProgressControl.vb#L38

Private Sub UpdateProgressBar(ByVal value As Integer)
    progressBarControl1.EditValue = value
End Sub

winforms-grid-display-colored-progress-bars/VB/ColoredProgressBar/SingleRepositoryProgressBar.vb#L27

Dim pbc As ProgressBarControl = TryCast(_View.ActiveEditor, ProgressBarControl)
Dim percent As Integer = Convert.ToInt16(pbc.EditValue)
If percent < 25 Then

XPO_how-to-bind-data-to-winforms-controls-using-xpservermodeview-or-xpinstantfeedbackview/VB/XPServerModeViewDemo/ProgressForm.vb#L22

Public Sub Report(ByVal value As Integer) Implements IProgress(Of Integer).Report
    progressBarControl1.EditValue = value
End Sub