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

Initializes and displays a progress indicator.

Namespace: DevExpress.Services

Assembly: DevExpress.Data.v23.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)))