SysIconDisplayTooltip (Function)

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.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / System functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SysIconDisplayTooltip (Function)

In french: SysIconeAfficheBulle

Displays a tooltip for an icon found in the taskbar. This icon must have been added into the taskbar by SysIconAdd.

Example

// Prévient de la fin du traitement
SysIconDisplayTooltip("Le traitement est terminé.")

// Affichage d'un avertissement avec une procédure de clic
SysIconDisplayTooltip("Le traitement est relativement long. " + ...
	"Cliquez sur la bulle pour voir le détails des opérations.", ...
	sysTooltipTypeWarning, "", ProcédureDétail)

Syntax

<Result> = SysIconDisplayTooltip(<Message> [, <Title> [, <Type> [, <Icon> [, <WLanguage procedure>]]]])

<Result>: Boolean

True if the bubble has been displayed,
False otherwise.

<Message>: Character string

Text displayed in the tooltip (up to 255 characters).

<Title>: Optional character string

Title of the tooltip (up to 63 characters).

<Type>: Optional Integer constant

Type of the tooltip:
sysTooltipTypeWarning Warning tooltip. A warning icon is displayed in the tooltip (yellow panel).
sysTooltipTypeDefault
(Default value) Default bubble displayed (i.e. the bubble defined by function SysIconAdd).
sysTooltipTypeError Error tooltip. An error icon is displayed in the tooltip (white cross on red background).
sysTooltipTypeInfo Info tooltip. An information icon is displayed in the tooltip (white "i" on blue background).
sysTooltipTypeCustom Custom tooltip: The <Icon> parameter allows you to define the icon displayed in the tooltip.

<Icon>: Optional character string

Icon (16x16) displayed in the tooltip if <Type> is set to sysTooltipTypeCustom.
Corresponds to:
the name and full (or relative) path of the icon file to add. A UNC path is allowed.
the name of an Icon variable.
This parameter corresponds to an empty string ("") by default.

<WLanguage procedure>: Optional procedure name

WLanguage procedure that will be called during the click on the tooltip (procedure without parameter). This parameter is taken into account from Windows XP.

Remarks

The tooltip is closed when clicked on.
Starting with Windows 10, the bubble is displayed as a new notification via the Windows notification center. The notification center has rules that can block the display of notifications.
If the user uses the concentration mode, or if too many identical notifications are sent by the same application in too short a time, the notifications are deactivated by the system.

Component: wd300std.dll