Platforms to show: All Mac Windows Linux Cross-Platform
Back to TaskDialogMBS class.
TaskDialogMBS.AllowDialogCancellation as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Indicates that the dialog should be able to be closed using Alt-F4, Escape, and the title bar's close button even if no cancel button is specified in either the CommonButtons or Buttons members.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.CanBeMinimized as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
Some examples using this property:
TaskDialogMBS.CollapsedControlText as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This member is ignored when the ExpandedInformation member is empty. If this member is empty and the CollapsedControlText is specified, then the CollapsedControlText value will be used for this member as well.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.CommonButtons as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If no common buttons are specified and no custom buttons are specified through buttons array, the task dialog will contain the OK button by default. This parameter may be a combination of flags from the following group:
kCommonButtonOK | The task dialog contains the push button: OK. |
kCommonButtonYes | The task dialog contains the push button: Yes. |
kCommonButtonNo | The task dialog contains the push button: No. |
kCommonButtonCancel | The task dialog contains the push button: Cancel. If this button is specified, the task dialog will respond to typical cancel actions (Alt-F4 and Escape). |
kCommonButtonRetry | The task dialog contains the push button: Retry. |
kCommonButtonClose | The task dialog contains the push button: Close. |
Some examples using this property:
TaskDialogMBS.Content as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If the EnableHyperlinks flag is true, then this string may contain hyperlinks in the form: <A HREF="executablestring">Hyperlink Text</A>.
WARNING: Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
(Read and Write property)
TaskDialogMBS.DefaultButton as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This may be any of the values specified in ID of one of the buttons, or one of the IDs corresponding to the buttons specified in the CommonButtons property.
kIDCancel | Make the Cancel button the default. |
kIDNo | Make the No button the default. |
kIDOk | Make the OK button the default. |
kIDRetry | Make the Retry button the default. |
kIDYes | Make the Yes button the default. |
kIDClose | Make the Close button the default. |
You can also mark buttons default with their default flag.
(Read and Write property)
TaskDialogMBS.DefaultRadioButton as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If this value does not correspond to a button ID, the first button in the array is selected by default.
You can also mark buttons default with their default flag.
(Read and Write property)
TaskDialogMBS.DialogHandle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This is only valid (and non zero) while dialog is visible.
(Read only property)
TaskDialogMBS.EnableHyperlinks as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Enables hyperlink processing for the strings specified in the Content, ExpandedInformation and Footer members. When enabled, these members may point to strings that contain hyperlinks in the following form:
<A HREF="executablestring">Hyperlink Text</A>
Warning: Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
Note: Task Dialogs will not actually execute any hyperlinks. Hyperlink execution must be handled in the HyperlinkClicked event.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ExpandedByDefault as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This flag is ignored if the ExpandedInformation member is empty.
(Read and Write property)
TaskDialogMBS.ExpandedControlText as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This member is ignored when the ExpandedInformation member is empty. If this member is empty and the CollapsedControlText is specified, then the CollapsedControlText value will be used for this member as well.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ExpandedInformation as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The additional information is displayed either immediately below the content or below the footer text depending on whether the ExpandFooterArea flag is true. If the EnableHyperlinks flag is true, then this string may contain hyperlinks in the form: <A HREF="executablestring">Hyperlink Text</A>.
WARNING: Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ExpandFooterArea as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Indicates that the string specified by the ExpandedInformation member is displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content. This flag is ignored if the ExpandedInformation member is empty.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.Flags as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
You should not need to set flags as we have properties for all relevant flags.
(Read and Write property)
TaskDialogMBS.Footer as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If EnableHyperlinks is true, this can show clickable links.
(Read and Write property)
TaskDialogMBS.FooterIconPicture as Picture
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The picture must have a valid mask.
(Read and Write property)
Some examples using this property:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Can be one of the kIcon* constants.
Or you set IconPicture property.
(Read and Write property)
TaskDialogMBS.IconPicture as Picture
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The picture must have a valid mask.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.MainInstruction as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
Some examples using this property:
TaskDialogMBS.NoDefaultRadioButton as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
TaskDialogMBS.parent as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Can reference a Window or DesktopWindow object.
(Read and Write property)
TaskDialogMBS.parentHandle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
TaskDialogMBS.PositionRelativeToWindow as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If the flag is not supplied (or no parent member is specified), the task dialog is positioned (centered) relative to the monitor.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ProgressbarMax as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Default is 100.
This is a live property. Setting it while dialog is open will change the control.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ProgressbarMin as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This is a live property. Setting it while dialog is open will change the control.
(Read and Write property)
TaskDialogMBS.ProgressbarState as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Default kProgressbarNone.
Can be set to other states to turn on progressbar.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.ProgressbarValue as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This is a live property. Setting it while dialog is open will change the control.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.RightToLeftLayout as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
TaskDialogMBS.SelectedButton as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
Some examples using this property:
TaskDialogMBS.SelectedRadioButton as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
Some examples using this property:
TaskDialogMBS.Showing as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
Some examples using this property:
TaskDialogMBS.TimedOut as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read only property)
TaskDialogMBS.timeoutMS as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
In Milliseconds. The dialog closes after given time.
(Read and Write property)
TaskDialogMBS.VerificationChecked as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Before: Indicates whether the verification checkbox in the dialog is checked when the dialog is initially displayed.
After: True if the verification checkbox was checked when the dialog was dismissed.
This is a live property. Changing it while the dialog is open will change the checkbox.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.VerificationEnabled as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Can be true to enable the checkbox or false to disable.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.VerificationText as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If this parameter is empty, the verification checkbox is not displayed in the task dialog. If the VerificationEnabled is false, the checkbox is not enabled.
(Read and Write property)
Some examples using this property:
TaskDialogMBS.Width as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If 0, the task dialog manager will calculate the ideal width.
(Read and Write property)
TaskDialogMBS.WindowTitle as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read and Write property)
TaskDialogMBS.Yield as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Whether the plugin should yield time to other Xojo threads while dialog is open.
(Read and Write property)
The items on this page are in the following plugins: MBS Win Plugin.