TaskDialog

Description:

baTaskDialog shows a Vista style Task Dialog.

Platforms:

Windows

Usage:

Result = baTaskDialog( Options )

Arguments:

List.
Options is a property list with the dialog options. See Notes for details.

Returns:

List.
Returns a list with the result of the dialog. There will always be a #button entry in the list with the #button equal to the number of the button the user clicked, or 0 if the user cancelled. See Notes for more details.

Examples:

Director:
Options = [ #Message: "This is a task dialog. Do you like it?", #Button1: "Yes", #Button2: "No" ]
res = baTaskDialog( Options )
if res.button = 1 then -- user selected Yes.

Authorware:
This function is not available for Authorware.
 

Notes:

The Task Dialog has a large number of options. All are optional, but leaving out some will not make sense. At teh least, you should include a #Message and #Button1.

The options available are:

#Message 

The main message.

#Title 

The title of the dialog.

#Content 

Smaller text under the main message.

#Footer 

Small text at the bottom of the dialog.

#Button1, #Button2, etc 

The text for the buttons.
Up to 5 different buttons can be defined.
You can place a RETURN in the text to make a second line with more information. For example:
[ #Button1: "Yes" & RETURN & "I really do want to do this." ]

#DefaultButton: 

Set to the number of the button to use as the default.

#StandardButtons 

Set to 1 to use standard buttons instead of links.

#NoCommandIcon 

Set to 1 to not show a icon beside the buttons.

#CloseButton 

Set to 1 to include a close button in the title bar.
If the user clicks this button, then the #button property in the return list will be 0.

#Icon 

The icon to show.
Can be "Error", "Information", "Warning", "Shield" or the full path to an .ico file.

#FooterIcon 

The icon to show beside the Footer text.
Can be "Error", "Information", "Warning", or the full path to an .ico file.
Only available if #Footer is supplied.

#ExpandedInformation 

Text to show when user clicks the "More details" button.

#CollapsedControlText 

Text to use for the "More details" button.

#ExpandedControlText 

Text to use for the "Fewer details" button.

#ExpandedInFooter 

Set to 1 to show the #ExpandedInformation text in the footer instead of below the main message.

#OpenExpanded 

Set to 1 to expand the #ExpandedInformation text when the dialog is opened.

#EnableHyperlinks 

Set to 1 to enable the use of hyperlinks in the #Content, #Footer or #ExpandedInformation text.
For example:
[ #Content: "Visit the <A HREF=" & QUOTE & "http://www.mods.com.au" & QUOTE & ">Buddy API</A> web site." , #EnableHyperlinks: 1 ]

#VerificationText 

Text to show with a check box beside it.
If this option is included, then the return list will include an #checked entry set to 1 if the check box was checked when the dialog was closed or 0 if it wasn't.

#VerificationChecked 

Set to 1 to check the verification box when the dialog is opened.

#Radio1, #Radio2, etc 

The text for radio buttons.
Up to 5 radio buttons can be defined.
If this option is included, then the return list will include an #radio entry set to the number that was selected when the dialog was closed.

#DefaultRadioButton 

Set the number of the radio button to be selected when the dialog is opened.

#CenterOnStage 

Set to 1 to center the dialog on the Director/Authorware window, instead of the center of the screen.

#Emulated: 

Set to 1 to use emulated mode on Vista.
This function is only native on Vista, on earlier versions the dialog will be emulated. There will be visual  differences between the emulated and the native dialogs. Use this option to have the dialog look the same on all Windows, although that will mean on Vista, the standard dialog will not be used and may not follow the user's interface preferences.

See also:

baMsgBox
baMsgBoxEx