Show Flash Dialog (script step reference)

By October 1, 2019 October 13th, 2019 Online Help, Troi Dialog Plug-in
Troi Dialog Plug-in for FileMaker Pro

Show Flash Dialog

Displays a flash dialog box for a specified period of time.

SyntaxScript step badge

Show Flash Dialog [ Select ; Result ; Ticks ; Dialog text ; Countdown text ;
                    Switches ; Icon ; Custom Icon ]

Options

Select entire contentsreplaces the entire contents of a field with the result. If not checked the result replaces the currently selected portion of the field
Resultthe result (currently always 0)
Ticksthe time this dialog must be visible, in 1/60th of a second
Dialog textspecifies the text you want to display
Countdown text(optional) a text at the bottom of the dialog that will countdown the seconds remaining
Switchesthis determines the behavior of the dialog and which information is returned
Iconselect one of "No Icon", "Note Icon", "Caution Icon", "Stop Icon", "Custom Icon" or leave empty
Custom Icon(optional) container with the icon to show

Switches

When you leave the Icon parameter empty you can also add one of these switches:

-NoteIconshows a note icon (indicating this dialog gives the user information)
-CautionIconshows a caution icon (indicating this dialog warns the user)
-StopIconshows a stop icon (indicating this is something severe which the user needs to address )
-CustomIconshows a custom icon. This icon needs to be set before with the Dial_IconControl function

You can also add this switch:

-IconSize=48display the icon at 48×48 pixels

Returned Result

Data type returned

Number

Result

This function always returns 0.

Originated in

Troi Dialog Plug-in 7.0

Compatibility

FileMaker Pro 16 to 18

Considerations

You can hold flash dialogs on the screen longer, or get rid of them early. This is what is possible:

– To dismiss a flash dialog: click on the dialog or press the ENTER or SPACE key.
– To keep a flash dialog longer on the screen: click on the dialog and hold the mouse button down. Or keep the ENTER or SPACE key down. When you release the mouse button or key the dialog goes away.

The parameter Countdown Text was added in v8.0: When you specify a countdown text the string “<secs>” will be replaced with the actual time in seconds remaining. So use for example the text: “This dialog will dismiss in <secs> seconds.”

Example

Show Flash Dialog [ $Result ; 120 ; "Have a nice day" ]

This will show a flash dialog box for 120 ticks = 2 seconds.

Example 2

We assume that in your FileMaker file the following fields are defined:

gDialogText		Global, text
gTicksPrefs		Global, text
gIcon			Global, container with a (png) image in this field

The gDialogText field contains the text you want to display, and can be filled for example with a calculation. gTicksPrefs should be filled with a time in 1/60th of a second. You can then use this as a preference. Add the following script steps:

Set Variable [ $MyCustomIcon ; gIcon ] 
Show Flash Dialog [ $Result ; gTicksPrefs ; gDialogText ; "" ; "Custom Icon" ; 
			$MyCustomIcon ]

This shows a flash dialog with the text and the custom icon.

Example 3

Set Variable [ $Message ; "Hello there!"  ]
Set Variable [ $CountdownText ; "This flash dialog will dismiss in <secs> seconds."  ]
Show Flash Dialog [ $Result ; 5 * 60 ; $Message ; $CountdownText ]

This will show a flash dialog box for 5 seconds, with the text counting down to zero.

Related functionFunction badge

Dial_FlashDialog

Related topics

Troi Dialog Plug-in online help (overview)


Online Help Page for Troi Dialog Plug-in for 14 to 18 –> Show Flash Dialog (dialp7303) 2019-1013 20:06:42