SysOperationProgress::newMultiBar Method [AX 2012]

2013-12-02

Constructs an instance of the SysOperationProgress class as a multi-bar progress indicator.

Syntax

client server public static SysOperationProgress newMultiBar(
    int numOfBars, 
    Filename animation, 
    Caption caption, 
   [int textLength])

Run On

ClientOrServer

Parameters

numOfBars
Type: int
The number of progress bars.

animation
Type: Filename Extended Data Type
The name of the animation file (.avi) to be displayed.

caption
Type: Caption Extended Data Type
The progress form's caption.

textLength
Type: int
The maximum length (in characters) for the progress text before the text wraps to an additional line; optional.

Return Value

Type: SysOperationProgress Class
The new instance of the SysOperationProgress class.

Remarks

Remember to set the number of steps for each bar with the setTotal.The time remaining is calculated with regard to the progress of the first bar. Therefore, you must design your process so that the first bar shows the overall progress and the other bars show the progress of sub-tasks. If you have many sub-tasks, only two bars should be displayed at any time: one for the overall progress and one for the sub-tasks. Use the setCount to enable the progress bar position to reset itself.For more information about how to create multiple progress bars, see [How to: Create Progress Indicators].

Share via