DisplayBalloonTip command

The DisplayBalloonTip command displays a balloon tooltip with its stem pointing to the icon in the system notification area.

 

Syntax

String$='Title, Text, ModifyFlags, PathToFile, IconIndex'

Integer=IconFlag

PluginSet("PlugIn","Integer")

PluginSet("PlugIn","String$")

PluginRun("PlugIn","DisplayBalloonTip")

Parameters

IconFlag

[in] Flag value that determines icon for a balloon ToolTip:

 

0

No icon.

1

An information icon.

2

A warning icon.

3

An error icon.

4

Windows XP SP2 and later: User-defined icon. If this flag set then balloon message can display the same icon as in tray (Windows XP SP2) or any user-defined icon (Windows Vista and later).

Title

[in] A string containing a title for a balloon tooltip.

Text

[in] A string with the text for a balloon tooltip.

ModifyFlags

[in] This parameter is optional. The modifying flags that affect to the balloon tip appearance:

 

NOSOUND

Do not play the associated sound.

LARGEICON

Windows Vista and later: The large version of the icon should be used as the balloon icon.

 

The modifying flags can be used separately or combined using '+' symbol.

PathToFile

[in] Windows Vista and later: Path to the file containing icon to be loaded. This parameter used only if IconFlag is equals to 4 (user-defined icon). Supported file formats are .ico, .exe, .dll and .cpl. When .ico file is used then the last parameter IconIndex is ignored.

IconIndex

[in] Windows Vista and later: Usually .exe, .dll or .cpl files contain more than one icon in resources. This parameter allows to specify zero-based index of the icon to be loaded. When PathToFile parameter points to the .ico file this parameter is ignored.