Dial_ProgressBar (function reference)

By October 1, 2017 November 14th, 2018 Online Help, Troi Dialog Plug-in
Troi Dialog Plug-in for FileMaker Pro

Dial_ProgressBar

Displays a progress bar dialog box.

SyntaxFunction badge

Dial_ProgressBar ( switches ; command ; maxval/incrval ; text ) ]

Parameters

switches
commandthe command to be used
maxvalthe number of steps that should be used
incrvalindicates how much steps the progress bar should increase
textthe text to be shown

Switches

The first ‘command’ parameter indicates the commands, which may be: Show, Incr or Stop. They are to be used as follows:
1- Show command: makes the progress bar dialog box visible.
2- Incr command: increases the progress bar (multiple times, usually in a loop).
3- Stop command: the dialog is removed.

Returned Result

Data type returned

Error code

Result

This function returns 0 as result.

Originated in

Troi Dialog Plug-in 1.2

Compatibility

FileMaker Pro 12 to 17

Considerations

If you specify a zero as maxval, an indefinite progress bar is shown (barber pole).

In some cases the time to perform lengthy scripts might increase, as FileMaker updates the screen after the ProgressBar step. A freeze screen step does not always help.

IMPORTANT Use only in a script. Do not use this function in a calculated field definition, because when FileMaker calculates the fields this will result into a repeated dialog for EACH record. Also note that functions that use the clipboard, like pasting in a container field, will not work, as they try to paste in the progress bar window.

See also the Dial_SetPreference function to change the time of automatic removal of a progress dialog.

You can also suppress the title in all ProgressBar dialogs by adding this to your (startup) script:

Dial_SetPreference ( "-TitlesInProgressBarDialogs" ; "off" )

This will set the Progress bar title to blank for all subsequent calls until FileMaker is restarted.

Example

Use this function to indicate to a user that a script is doing a lengthy operation and provide feedback on how long this operation will last.

For a detailed description see the section “Using the Dial_ProgressBar function” in the user guide.

Related functionFunction badge

Dial_SetPreference

Related topics

Troi Dialog Plug-in online help (overview)


Online Help Page for Troi Dialog Plug-in for 14 to 17 –> Dial_ProgressBar (dialp4310) 2018-1114 15:07:06