ToastDisplay (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English (generic vocabulary)

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Toast functions

Managing 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 does not take focus, is not modal and does not interrupt application execution.

The display of toasts is recommended for conveying information to the user without blocking execution of the application (e.g. displaying a message to indicate the end of a download).

This function is available for Linux WEBDEV websites only.

New in version 2025

Default toast display improved. By default:

the corners of the toast are automatically rounded.
an outer margin is defined between the edge of the toast and the edge of the parent don.
toast opening and closing animation corresponds to the animation defined in the project options ("Field animations" option, in the "Advanced" tab of the project description).

Example

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
MyToast.ActionClose = clickClose
ToastDisplay(MyToast)
INTERNAL PROCEDURE FuncHelp
	Open ("WIN_Help")
END
INTERNAL PROCEDURE clickClose(nButton)
	Trace("Click to close. Button: " + nButton)
END

ToastDisplay("This is a Toast message.")

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

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

Syntax

Displaying a toast based on a Toast variable Hide the details

ToastDisplay(<Toast>)

<Toast>: Toast variable

Name of the Toast variable that defines the toast to be displayed.
Note: The Toast variable can be used to define a number of parameters.

Defining and displaying a toast Hide the details

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

<Message>: Character string

Message to display. This message can be multiline

<Display duration>: Optional integer

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

Note The exact display time 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.
vaMiddle The Toast message is displayed in the middle.
vaTop The Toast message is displayed at the top.

Starting with Android 11, it is no longer possible to set the position of toast messages. This parameter is ignored.

<Horizontal alignment>: Optional integer

Constant indicating the horizontal alignment of the 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.
haLeft The Toast message is displayed on the left.
This constant is not available.
haRight The Toast message is displayed on the right.
This constant is not available.

Starting with Android 11, it is no longer possible to set the position of toast messages. This parameter is ignored.

<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 WLanguage preset color.
This parameter is not available.

Remarks

Managing 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 changed using the Overlayable property of the Toast variable. This property restores the behaviour of version 24: the toasts are superimposed one on top of the 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: wd300obj.dll