Toast (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Properties specific to the description of Toast variables
WLanguage functions that manipulate Toast variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Toast (Type of variable)

In french: Toast

The Toast type is used to define all the advanced characteristics of a toast notification. The characteristics of this toast can be defined and modified using different WLanguage properties.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Versions 26 and later

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

New in version 26

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

Example

MyToast is Toast
MyToast.Title = "Did you know?"
MyToast.Text = "AAFs are really cool."
MyToast.Button [1].Label = "More information..."
MonToast.Bouton[1].ActionClic = FoncAide
ToastDisplay(MyToast)
INTERNAL PROCÉDURE FuncHelp
Open("WIN_Help")
END

// Displays a toast without the product name
MyToast is Toast
MyToast.DisplayDuration = toastLong
MyToast.VerticalAlignment = vaBottom
MyToast.HorizontalAlignment = haCenter
ToastDisplayIW(IW_TOAST_DELETE, MyToast, PRODUCT.NAME)

//------------------------------------
// Global declarations of the internal window
PROCÉDURE IW_TOAST_DELETE(ProductName)
STC_TEXT = StringBuild("The product %1 has been deleted", ProductName)

Remarks

Properties specific to the description of Toast variables

The following properties can be used to manipulate a toast notification:


Property name		Type used	Effect
Button[ n]			Buttons displayed in the toast.
	Button[n].ActionClick		Action to perform when the button is clicked on. This property corresponds to the name of the Procedure to be launched when clicking on the button displayed in the toast.
	Button[n].Caption		Button caption.
HorizontalAlignment		Integer constant	Horizontal alignment of the message, relative to the window: haCenter (Default value): The Toast message is displayed in the center. haRight: The Toast message is displayed on the right. haLeft: The Toast message is displayed on the left. Versions 26 and later Not available. New in version 26 Not available. Not available.
VerticalAlignment		Integer constant	Vertical alignment of the message, relative to the window: 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. Versions 26 and later Not available. New in version 26 Not available. Not available.
BackgroundColor		entier	Background color used to display the message. This parameter can correspond to: an RGB color (returned by RGB), an HSL color (returned by HSL), une preset color of WLanguage.
DisplayDuration		Integer constant	Display duration of toast notification: 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.
CloseOnClick		Boolean	Manage closing of toast: True: the toast closes automatically if the user clicks on it, False: the toast closes after the specified display time. Versions 26 and later Not available. New in version 26 Not available. Not available.
Opacity		entier	Opacity level of the toast with a value between 0 and 100: 0, default value, transparent toast, 100, for a toast with maximum opacity.
Overlayable		Boolean	True (default value): if several toasts are displayed, they overlap each other. False: if several toasts are displayed, they overlap each other (compatible version 24). Versions 26 and later Not available. New in version 26 Not available. Not available.
Text		Character string	Message to display.
Title		Character string	Toast title. Versions 26 and later Not available. New in version 26 Not available. Not available.

WLanguage functions that manipulate Toast variables


Versions 16 and later ToastDisplay New in version 16 ToastDisplay ToastDisplay	Displays a "Toast" message.
Versions 25 and later ToastDisplayIW New in version 25 ToastDisplayIW ToastDisplayIW	Opens a toast whose content is based on an internal window.

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.