SysIconDisplayTooltip (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

System functions

SysIconDisplayTooltip

SysBatteryOptimBackground

SysCacheExternalStorage

SysChangeEnvironment

SysChangeScreenResolution

SysColor

SysColorRes

SysDetectLockedSession

SysDeviceInfo

SysDir

SysDirExternalStorage

SysIconDisplayTooltip

SysListScreenOrientation

SysListScreenResolution

SysListVideoCard

SysMemoryExternalStorage

SysRemovableExternalStorage

SysStatusExternalStorage

SysStatusStorageCard

SysTheme

SysThumbnailAddButton

SysThumbnailDeleteAll

SysThumbnailDeleteButton

SysThumbnailModifyButton

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.

Remark: From Windows 10, the tooltip is displayed as a new notification by the notification center integrated into Windows.

Example

// Informs that the process has ended
SysIconDisplayTooltip("The process is ended.")

// Display a warning with a click procedure
SysIconDisplayTooltip("The process is quite long. " + ...
"Click the tooltip to see the details of operations.", ...
sysTooltipTypeWarning, "", ProcedureDetails)

Syntax

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

<Result>: Boolean

True if the tooltip was displayed,
False otherwise.

<Message>: Character string (with quotes)

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

<Title>: Optional character string (with quotes)

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) Tooltip displayed by default (which means the tooltip defined by 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 is used to define the icon displayed in the tooltip.

<Icon>: Optional character string (with quotes)

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>: Name of optional procedure

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.

Component : wd260std.dll