<Toast>.Display (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Managing threads
Successive calls

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Toast>.Display (Function)

In french: <Toast>.Affiche

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. Toasts are modeless, don't take focus and don't interrupt the execution of the application.

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

New in version 2025

Toasts have been improved. By default:

the corners of the toast are automatically rounded.
an external margin is set between the border of the toast and that of its parent.
the opening and closing animations of the toast are the ones defined in the project options (project description window, "Advanced" tab, "Control animations").

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

Syntax

<Toast>.ToastDisplay()

<Toast>: Toast variable

Name of the Toast variable that defines the toast to be displayed.

Remarks

Managing threads

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

Successive calls

If <Toast>.Display 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 allows you to get the same behavior as in version 24, in which toasts could be displayed one over another.

If <Toast>.Display is called several times, only the last call to the function will be taken into account.

Related Examples:

Training (WINDEV): WD Toasts

[ + ] This example shows how to use the ToastDisplay and ToastDisplayIW functions as well as Toast variables. A Toast is a temporary message used to inform the user without interrupting the application.

Business / UI classification: UI Code

Component: wd300obj.dll