Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

FM.InsertSetUpdateProgressDialog

Enable updating progress bar.

Component Version macOS Windows Linux Server iOS SDK
FM FMSQL 6.2 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "FM.InsertSetUpdateProgressDialog"; Update { ; Base; Factor } )   More

Parameters

Parameter Description Example Flags
Update Pass 1 to update Progress Dialog.
Pass 0 to disable feature.		 1
Base The progress base in percent.
Default is 0.		 25 Optional
Factor The factor to apply for progress update.
Default is 1.		 0.5 Optional

Result

Returns OK or error.

Description

Enable updating progress bar.
If you enable progress dialog updates, the functions FM.InsertRecordQuery, FM.InsertRecordQueryIgnoreDuplicates and FM.InsertRecordTSV will update progress dialog.
If cancel button is clicked, the functions may cancel and return an error. Depending on event handling a cancel button may not work while a plugin function runs!

You can use Base/Factor to adjust updates in progress dialog. e.g. if you have 4 things to do and FM.InsertRecordTSV is 2nd one, you can use a base of 25 (so 25% is for first thing to do) and factor of 0.25. Our progress will go from 25 to 50% than.

Examples

Import tab return text data as records with progress dialog:

Set Variable [$r; Value:MBS( "ProgressDialog.SetTitle"; "Please wait." )]
Set Variable [$r; Value:MBS( "ProgressDialog.SetShowButton"; 0 )]
Set Variable [$r; Value:MBS( "ProgressDialog.SetTopText"; "Importing text file..." )]
Set Variable [$r; Value:MBS( "ProgressDialog.Show" )]
Set Variable [$r; Value:MBS( "FM.InsertSetUpdateProgressDialog"; 1)]
Set Variable [$r; Value:MBS( "FM.InsertRecordTSV"; ""; "TSV Import"; "First¶Last¶Street¶City¶State¶Zip¶Country"; TSV Import::Text to Import )]
Set Variable [$r; Value:MBS( "ProgressDialog.Hide" )]

See also

Blog Entries

This function is free to use.

Created 3th April 2016, last changed 18th September 2016


FM.InsertRecordTSV - FM.IsMainThread