IProgressIndicationService Interface

Exposes functionality that enables you to display a progress indicator for time-consuming operations.

Namespace: DevExpress.Services

Assembly: DevExpress.Data.v20.2.dll

NuGet Packages: DevExpress.Data, DevExpress.WindowsDesktop.Data

Declaration

C#

public interface IProgressIndicationService

VB.NET

Public Interface IProgressIndicationService

Remarks

The IProgressIndicationService interface can be used in RichEditControl to track the progress of export, import and mail merge operations. In this case, it is called internally by the RichEditControl only if the projected duration of an operation exceeds a certain threshold (ca. 500 ms)

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075

MyProgressIndicator.cs

class MyProgressIndicatorService : IProgressIndicationService
{
    private ProgressBarControl _Indicator;
    public ProgressBarControl Indicator
    {
        get { return _Indicator; }
        set { _Indicator = value; }
    }

    public MyProgressIndicatorService(IServiceProvider provider, ProgressBarControl indicator)
    {
        _Indicator = indicator;
    }

    #region IProgressIndicationService Members

    void IProgressIndicationService.Begin(string displayName, int minProgress, int maxProgress, int currentProgress)
    {
        _Indicator.Properties.Minimum = minProgress;
        _Indicator.Properties.Maximum = maxProgress;
        _Indicator.Properties.ShowTitle = true;
        _Indicator.EditValue = currentProgress;
        _Indicator.Refresh();
        _Indicator.Show();            
    }

    void IProgressIndicationService.End()
    {
        _Indicator.Refresh();
        _Indicator.Hide();
    }

    void IProgressIndicationService.SetProgress(int currentProgress)
    {
        _Indicator.EditValue = currentProgress;
        _Indicator.Refresh();
    }
    #endregion
}

MyProgressIndicator.vb

Friend Class MyProgressIndicatorService
    Implements IProgressIndicationService
    Private _Indicator As ProgressBarControl
    Public Property Indicator() As ProgressBarControl
        Get
            Return _Indicator
        End Get
        Set(ByVal value As ProgressBarControl)
            _Indicator = value
        End Set
    End Property

    Public Sub New(ByVal provider As IServiceProvider, ByVal indicator As ProgressBarControl)
        _Indicator = indicator
    End Sub

    #Region "IProgressIndicationService Members"

    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
        _Indicator.Properties.ShowTitle = True
        _Indicator.EditValue = currentProgress
        _Indicator.Refresh()
        _Indicator.Show()
    End Sub

    Private Sub [End]() Implements IProgressIndicationService.End
        _Indicator.Refresh()
        _Indicator.Hide()
    End Sub

    Private Sub SetProgress(ByVal currentProgress As Integer) Implements IProgressIndicationService.SetProgress
        _Indicator.EditValue = currentProgress
        _Indicator.Refresh()
    End Sub

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075

Form1.cs

using DevExpress.Services;
            richEditControl1.ReplaceService<IProgressIndicationService>
                (new MyProgressIndicatorService(richEditControl1, this.progressBarControl1));

Form1.vb

Imports DevExpress.Services
            richEditControl1.ReplaceService(Of IProgressIndicationService) _
 (New MyProgressIndicatorService(richEditControl1, Me.progressBarControl1))

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IProgressIndicationService interface.

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#

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/MyProgressIndicator.cs#L12

#region #myprogressindicator
class MyProgressIndicatorService : IProgressIndicationService
{

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/CS/ProgressIndicator/MyProgressIndicator.cs#L12

#region #myprogressindicator
class MyProgressIndicatorService : IProgressIndicationService
{

VB.NET

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/MyProgressIndicator.vb#L12

Friend Class MyProgressIndicatorService
    Implements IProgressIndicationService

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/VB/ProgressIndicator/MyProgressIndicator.vb#L13

Friend Class MyProgressIndicatorService
    Implements IProgressIndicationService
    Private _Indicator As ProgressBarControl