Platforms to show: All Mac Windows Linux Cross-Platform
TaskDialogMBS class
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This class function creates, displays, and operates a task dialog. The task dialog contains application-defined icons, messages, title, verification check box, command links, push buttons, and radio buttons.
Requires Windows Vista or newer.
- 11 events
- event ButtonClicked(ID as Integer) as boolean
- event Close
- event Constructed
- event ExpandButtonClicked(Expanded as Boolean)
- event Help
- event HyperlinkClicked(link as string)
- event Navigated
- event Open
- event RadioButtonClicked(ID as Integer) as boolean
- event Timer(Time as Integer)
- event VerificationClicked(Checked as Boolean)
- 41 properties
- property AllowDialogCancellation as Boolean
- property CanBeMinimized as Boolean
- property CollapsedControlText as String
- property CommonButtons as Integer
- property Content as String
- property DefaultButton as Integer
- property DefaultRadioButton as Integer
- property DialogHandle as Integer
- property EnableHyperlinks as Boolean
- property ExpandedByDefault as Boolean
- property ExpandedControlText as String
- property ExpandedInformation as String
- property ExpandFooterArea as Boolean
- property Flags as Integer
- property Footer as String
- property FooterIconPicture as Picture
- property Icon as Integer
- property IconPicture as Picture
- property MainInstruction as String
- property NoDefaultRadioButton as Boolean
- property parent as Variant
- property parentHandle as Integer
- property PositionRelativeToWindow as Boolean
- property ProgressbarMax as Integer
- property ProgressbarMin as Integer
- property ProgressbarState as Integer
- property ProgressbarValue as Integer
- property RightToLeftLayout as Boolean
- property SelectedButton as Integer
- property SelectedRadioButton as Integer
- property Showing as Boolean
- property TimedOut as Boolean
- property timeoutMS as Integer
- property VerificationChecked as Boolean
- property VerificationEnabled as Boolean
- property VerificationText as String
- property Width as Integer
- property WindowTitle as String
- property Yield as Boolean
- property Button(index as Integer) as TaskDialogButtonMBS
- property RadioButton(index as Integer) as TaskDialogButtonMBS
- 5 methods
- method AppendButton(button as TaskDialogButtonMBS)
- method AppendRadioButton(button as TaskDialogButtonMBS)
- method CloseDialog
- method FindButtonByID(ID as Integer) as TaskDialogButtonMBS
- method ShowDialog as Boolean
- 24 constants
Common Buttons
| Constant | Value | Description |
|---|---|---|
| kCommonButtonCancel | 8 |
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). |
| kCommonButtonClose | 32 |
The task dialog contains the push button: Close. |
| kCommonButtonNo | 4 |
The task dialog contains the push button: No. |
| kCommonButtonOK | 1 |
The task dialog contains the push button: OK. Example |
| kCommonButtonRetry | 16 |
The task dialog contains the push button: Retry. |
| kCommonButtonYes | 2 |
The task dialog contains the push button: Yes. |
Icon Constants
| Constant | Value | Description |
|---|---|---|
| kIconApplication | 5 |
An application icon appears in the task dialog. |
| kIconError | 2 |
A stop-sign icon appears in the task dialog. |
| kIconInformation | 3 |
An icon consisting of a lowercase letter i in a circle appears in the task dialog. |
| kIconNone | 0 |
No icon. |
| kIconShield | 4 |
A shield icon appears in the task dialog. |
| kIconWarning | 1 |
An exclamation-point icon appears in the task dialog. |
Standard Button IDs
| Constant | Value | Description |
|---|---|---|
| kIDAbort | 3 |
Abort button |
| kIDCancel | 2 |
Cancel button |
| kIDIgnore | 5 |
Ignore button |
| kIDNo | 7 |
No button |
| kIDOK | 1 |
OK Button |
| kIDRetry | 4 |
Retry Button |
| kIDYes | 6 |
Yes Button |
Progressbar State
| Constant | Value | Description |
|---|---|---|
| kProgressbarError | 3 |
Error state. |
| kProgressbarMarquee | 8 |
Marquee state |
| kProgressbarNone | 0 |
No progress bar. |
| kProgressbarNormal | 1 |
Normal progressbar |
| kProgressbarPause | 2 |
Paused progress bar |
This class has no sub classes.
Blog Entries
- MBS Xojo Plugins, version 21.6pr3
- MBS Xojo / Real Studio plug-ins version 16.2
- MBS Xojo / Real Studio Plugins, version 16.2pr2
- New TaskDialog Class
Release notes
- Version 22.0
- Changed window properties to variant, so you can use DesktopWindow there for WindowsShortCutMBS, WindowsPrintDialogMBS, WindowsPageSetupDialogMBS, WindowsICMSetupMBS, WindowsBlueToothSelectDeviceDialogMBS, TwainMBS, TaskDialogMBS, OpenDialogMBS, DirectShowVideoWindowMBS, WindowsStoreContextMBS, WindowsFileCopyMBS, WindowsFontDialogMBS, WindowsPreviewHandlerMBS, WindowsStoreContextMBS, ParentChromiumFrameMBS and ChromiumBrowserMBS classes.
Some examples using this class:
Some related classes:
- class ChromiumBrowserMBS
- class DirectShowVideoWindowMBS
- class OpenDialogMBS
- class TaskDialogButtonMBS
- class TwainMBS
- class WindowsPageSetupDialogMBS
- class WindowsPreviewHandlerMBS
- class WindowsPrintDialogMBS
- class WindowsShortCutMBS
- class WindowsStoreContextMBS
The items on this page are in the following plugins: MBS Win Plugin.
TaskDialogButtonMBS - TCPSocket
