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

Initializes and displays a progress indicator.

Namespace: DevExpress.Snap.Core.Services

Assembly: DevExpress.Snap.v19.2.Core.dll

Declaration

C#

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

VB.NET

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

Parameters

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

Returns

Type	Description
Int32	An integer value, identifying the task.

Remarks

The value returned by this method is used as a token parameter of the ISnapProgressIndicationService.SetProgress and ISnapProgressIndicationService.End methods.