ToastDisplay (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Management of threads
Successive calls

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ToastDisplay (Function)

In french: ToastAffiche

Displays a "Toast" message.

Toasts are a short messages that appear on the screen for a few seconds before fading out without any user intervention. A Toast message does not take focus, it is not modal and it does not interrupt the execution of the application.

Toasts are recommended to show information to the user without locking the execution of the application (e.g.: display a message to indicate that the download has been completed).

This function is available for Linux WEBDEV sites only.

Versions 17 and later

This function is now available for WINDEV applications in Windows.

New in version 17

This function is now available for WINDEV applications in Windows.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Browser code.

This function is now available in WEBDEV Server (Windows and Linux).

This function is now available for PHP sites.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Browser code.

This function is now available in WEBDEV Server (Windows and Linux).

This function is now available for PHP sites.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Browser code.

This function is now available in WEBDEV Server (Windows and Linux).

This function is now available for PHP sites.

This function is now available in Windows Store apps mode.

Versions 20 and later

This function is now available for iPhone/iPad applications.

New in version 20

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

ToastDisplay("This is a Toast message.")

ToastDisplay("This is a Toast message.", toastLong, vaMiddle, haCenter, LightGreen)

// Customize the font used (gxxx functions)
ToastDisplay(gFontBold() + gFont("Batang") + gFontSize(18) + ...
gPen(LightYellow) + "My custom message", ...
toastShort, vaBottom, haRight, DarkRed)

Versions 25 and later

MyToast is Toast
MyToast..Title = "Did you know?"
MyToast..Text = "AAFs are really cool."
MyToast..Button[1]..Caption = "Learn more..."
MyToast..Button[1]..ActionClick = FuncHelp
ToastDisplay(MyToast)
INTERNAL PROCEDURE FuncHelp
Open ("WIN_Help")
END

New in version 25

Syntax

Defining and displaying a toast Hide the details

ToastDisplay(<Message> [, <Display duration> [, <Vertical alignment> [, <Horizontal alignment> [, <Background color>]]]])

<Message>: Character string (with quotes)

Message to display. This message can be multiline

<Display duration>: Optional integer

Constant indicating the display duration of Toast message:
toastShort
(Default value) The Toast message will be displayed during a short period of time.
toastLong The Toast message will be displayed during a long period of time.

Remark: The exact display duration depends on the device used.

<Vertical alignment>: Optional integer

Constant indicating the vertical alignment of message. This alignment is relative:
to the screen.
to the window.
to the page.
vaBottom
(Default value) The Toast message is displayed at the bottom.
vaTop The Toast message is displayed at the top.
vaMiddle The Toast message is displayed in the middle.

<Horizontal alignment>: Optional integer

Constant indicating the horizontal alignment of message. This alignment is relative:
to the screen.
to the window.
to the page.
haCenter
(Default value) The Toast message is displayed in the center.
The toast will always be centered horizontally.
haRight The Toast message is displayed on the right.
This constant is not available.
haLeft The Toast message is displayed on the left.
This constant is not available.

<Background color>: Optional integer

Background color used to display the message. This parameter can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
This parameter is not available.

Versions 25 and later

Displaying a toast based on a Toast variable Hide the details

ToastDisplay(<Toast>)

<Toast>: Toast variable

Name of the Toast variable describing the toast to display.
Remark: The Toast variable allows you to define additional parameters.

New in version 25

Displaying a toast based on a Toast variable Hide the details

ToastDisplay(<Toast>)

<Toast>: Toast variable

Name of the Toast variable describing the toast to display.
Remark: The Toast variable allows you to define additional parameters.

Displaying a toast based on a Toast variable Hide the details

ToastDisplay(<Toast>)

<Toast>: Toast variable

Name of the Toast variable describing the toast to display.
Remark: The Toast variable allows you to define additional parameters.

Remarks

Management of threads

ToastDisplay can be called from a WLanguage thread (to notify the user of events that occurred during the thread execution for example).

Successive calls

If ToastDisplay is called several times, each toast is displayed once the previous toast has disappeared. This behavior can be modified by using the ..Overlayable property of the Toast variable. This property allows you to get the same behavior as in version 24: toasts overlap each other.

If ToastDisplay is called several times, only the last call to the function will be taken into account.

Business / UI classification : UI Code

Component : wd260obj.dll