IProgressIndicationService.Begin(String, Int32, Int32, Int32) Method

Initializes and displays a progress indicator.

Namespace: DevExpress.Services

Assembly: DevExpress.Data.v22.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

void Begin(
    string displayName,
    int minProgress,
    int maxProgress,
    int currentProgress
)

VB.NET

Sub Begin(
    displayName As String,
    minProgress As Integer,
    maxProgress As Integer,
    currentProgress As Integer
)

Parameters

Name	Type	Description
displayName	String	A string indicating what action is currently performed
minProgress	Int32	An integer specifying the minimum indicator value.
maxProgress	Int32	An integer specifying the maximum indicator value.
currentProgress	Int32	An integer specifying the current indicator value.

Remarks

If you register a custom service that implements the IProgressIndicationService interface, then, when loading a document from the stream, you can call the Begin method as follows:

C#

MyProgressIndicationService.Begin("Loading from a stream...", (int)stream.Position, (int)(stream.Length - stream.Position), (int)(stream.Position));

VB.NET

MyProgressIndicationService.Begin("Loading from a stream...", CInt(Fix(stream.Position)), CInt(Fix(stream.Length - stream.Position)), CInt(Fix(stream.Position)))

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Begin(String, Int32, Int32, Int32) method.

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.

VB.NET

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/VB/ProgressIndicator/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

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

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