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

ProgressDialog.SetCancel

Sets the cancel state.

Component Version macOS Windows Linux Server iOS SDK
ProgressDialog 2.4 ✅ Yes ✅ Yes ❌ No ❌ No ✅ Yes
MBS( "ProgressDialog.SetCancel"; Flag )   More

Parameters

Parameter Description Example
Flag the new cancel state. 1

Result

Returns "OK" on success.

Description

Sets the cancel state.
You can query in your loop whether user clicked cancel so you can exit your loop.
If your script does not make a pause or a long running plugin functions runs, there may be no reaction on the cancel button.

Examples

Set cancel state

MBS( "ProgressDialog.SetCancel"; 1 )

Reset Cancel state:

MBS( "ProgressDialog.SetCancel"; 0 )

See also

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 15th October 2022


ProgressDialog.SetButtonCaption - ProgressDialog.SetFont