ToastDisplayIW (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

New WINDEV 25 feature!

Operating mode

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ToastDisplayIW (Function)

In french: ToastAfficheFI

Opens a toast notification whose content is based on an internal window.

Example

// 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
PROCEDURE IW_TOAST_DELETE(ProductName)
STC_TEXT = StringBuild("The product %1 has been deleted", ProductName)

Syntax

Display a toast based on an internal window (via the Toast variable) Hide the details

ToastDisplayIW(<Internal window> [, <Toast> [, <Parameter 1> [... [, <Parameter N>]]]])

<Internal window>: Name of internal window

Name of internal window used for the toast.
If this is the only parameter specified, the toast based on the internal window will be displayed at the default position (bottom) with the default display time (short).

<Toast>: Toast optional variable

Name of Toast variable that describes the characteristics of the toast.
Remark: ..Title and ..Text on a Toast variable are not taken into account.

<Parameter 1>: Type corresponding to the parameter (optional)

First parameter that will be passed to the internal window. This parameter is passed to the event "Global declarations" associated to the internal window

<Parameter N>: Type corresponding to the parameter (optional)

Nth parameter that will be passed to the internal window. This parameter is passed to the event "Global declarations" associated to the internal window

Defining and displaying a toast based on an internal window Hide the details

ToastDisplayIW(<Internal window> [, <Display duration> [, <Vertical alignment> [, <Horizontal alignment> [, <Background color>]]]])

<Internal window>: Name of internal window

Name of internal window used for the toast.
If this is the only parameter specified, the toast based on the internal window will be displayed at the default position (bottom) with the default display time (short).

<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 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.

<Horizontal alignment>: Optional integer

Constant indicating the horizontal alignment of message. This alignment is 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.

<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.
Caution: In order to change the background color of the internal window , you must use the "Transparent" background color in the editor.

Remarks

Operating mode

The content of the controls in the internal window (text, etc.) must be initialized before calling ToastDisplayIW. The first syntax allows you to pass parameters to the internal window if necessary.
If ToastDisplayIW is used to display several toasts at once, the different toasts and will be displayed one after the other (when the first toast is closed, the next toast will be displayed). This behavior can be modified by using the ..Overlayable property of the Toast variable.
By default, the size of the toast corresponds the size of the source internal window. This size can be modified/adapted in the "Initializing" event of the source internal window.

Component : wd250obj.dll