AppProgressCreate

AppProgressCreate creates a process control in the status bar or a dialog box with a progress control and a Cancel button.

bool = AppProgressCreate()

bool = AppProgressCreate(nUpper)

bool = AppProgressCreate(nUpper, nOption)

bool = AppProgressCreate(nLower, nUpper, nStep, nOption)

bool = AppProgressCreate(nLower, nUpper, nStep, nOption, ssTitle)

Return Value

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

Parameters

nLower

Default value is 0.

nUpper

Default value is 100.

nStep

Default value is 1.

nOption

0 oder 1: Progress control in the status bar. 2: Creates a progress dialog box. Defaultwert ist 0.

ssTitle

Titel for the progress dialog box, if nOption is set to 2. Defaultwert value is “Progress”.

Comment

Beginning with UniPlot R2015.8 calls of AppProgressDialog and AppProgressCreate can be nested. See AppProgressDialog.

Example

def TestAppProgressCreate()
{
    AppProgressCreate(67)
    for (i in 1:67) {
        AppProgressStepIt()
        AppSleep(50); // Simulate some work
    }
    AppProgressDestroy()
}

TestAppProgressCreate()

History

Version	Description
R2015.8	Progress bar with stack support.
R2012.1 (5.40.1)	bSmooth replaced by nOption and new parameter ssTitle.
5.14.4	Call with one parameter changed: Instead of bSmooth, nUpper is set.

See also

Overview Application Object, AppProgressStepIt, AppProgressDialog, AppProgressDestroy, ShowWaitCursor, AppSetStatusBarText

_id-972059