Progress Bar

) form object adds a progress bar to a form in an application. The progress bar can show progress based on a value that describes some progress in a running application using a method that updates the progress bar. You control the update and display of the progress in the progress bar by referring to the name that you enter in the field. For example, add the following two lines of code in a Method Editor window:

The first line starts progress for the progress bar object with the name progressbar1. The second line updates its progress to 12%. You can find a full listing of the available commands for controlling the progress under in the window, accessible in the section of the ribbon toolbar. You can also base the progress on the built-in model progress (the main progress in COMSOL Multiphysics) by selecting the check box. Optionally, it is then possible to use two levels of progress. Select from the list (default: ) to use two levels of progress (represented using two progress bars).

Select the check box to add a button underneath the progress bars to make it possible to cancel some progress in the application.

If the check box is selected, you can select or clear the check box. If that check box is selected, dialog forms are closed when a user clicks the button.

	You can also add a progress bar for the progress information from built-in actions, such as the solvers, in the Settings window for the Main Window node. A third option is to add a progress dialog for the application’s own progress using available methods such as startProgress(progressBarname), setProgress(int workDone), and closeProgress(). See the full list of Application Builder methods in the Introduction to the Application Builder document.

The window contains the following sections.

Under , you can control the initial state of the progress bar when users run the application. By default, the progress bar is visible and enabled. Clear the or check box if you want to make the initial state of the progress bar hidden or unavailable. You can then make it visible or enable it using a method. In the Form Editor, the state of the form object is indicated by a change in its appearance. Objects that are hidden become visible when selected in the Form Editor.

This section contains all layout settings for a progress bar in the grid of the parent form.

In the grid mode, you can control the horizontal and vertical alignment of the progress bar using the following lists:

•

From the list, choose , , , or , which automatically expands the form object to fill the cell in the horizontal or vertical direction (where applicable).

•

From the list, choose , , , or , which automatically expands the form object to fill the cell in the horizontal or vertical direction (where applicable).

The need to specify the alignment is most obvious when working in the grid mode, as it controls how the form object is aligned in its grid cell. Aligning the form object can be useful in the sketch mode too, and you can then use the alignment tools on the menu in the toolbar’s section. When running the application in any client other than the Windows client, the form objects may not be positioned exactly as seen in the form windows. This is because the form objects may have a different size in other clients, giving them a slightly different positioning. Specifying the alignment ensures that the form objects are aligned as you want them to be in all clients.

You can also specify the width of the progress bar. Enter a width (in points) in the field. If you have chosen from the list, you can instead specify a . Choose to compute the minimum width automatically (typically, this means a minimum size of 0) or choose to specify a minimum width in the text field underneath. The field is unavailable because the height of the progress bar is determined by the software.

Additionally, in the sketch mode, you can specify the absolute position of the progress bar using the and fields. In the grid mode, you can position the object in the grid and see the grid position as the , , , and values.

	The form windows update these size and positioning settings through the draw operations performed there, such as resizing and moving the object.

Under (in grid mode only), you can control the margins around the form object. By default, the margins are taken from the parent form. From the list, choose: