Displays a balloon tooltip over an item.
Syntax
rv = Send_Message(Ctrl, "OLE.ShowBalloonTooltip", Item, Config)
Parameters
| Parameter | Description |
|---|---|
| Item | The item over which the balloon tooltip is to appear |
| Config | The balloon tooltip configuration settings. (See Remarks) |
Remarks
The ShowBalloonTooltip method can be used to show a balloon tooltip over any single item.
The tooltip will always point to the center of the item's data. The Item parameter must be a key to a valid item. The Config parameter configures the tooltip using this multivalue structure:
| Pos | Name | Type | Description |
|---|---|---|---|
| <1> | Text | Text | The balloon tooltip text |
| <2> | Title | Text | An optional title for the balloon tooltip |
| <3> | Icon | Integer | 0 = No Icon, 1 = Info Icon, 2 = Warning Icon, 3 = Error Icon |
| <4> | Delay | Integer | Time in milliseconds to remain visible |
The configuration settings are very straightforward, just pass the ones you wish to change. If Delay is set to 0, then the balloon tooltip stays visible until the user clicks on it. If Delay is greater than zero, then the balloon tooltip will disappear when the time, in milliseconds, ellapses or until the user clicks on it--whichever comes first.
Multiline text is supported. Simply delimite your lines with CRLFs or @TMs.
Updating Tooltips
To update the contents of an already visible balloon tooltip, just call this method again.
Example
// Show a balloon tooltip over Item1 with an info icon and a 5 second time limit Config = "" Config<1> = "Multiple line test":@TM:"Line 1":@TM:"Line 2" Config<2> = "This is My Title" Config<3> = 1 Config<4> = 5000 rv = Send_Message(@Window:".OLE_TREE", "OLE.ShowBalloonTooltip", "Item1", Config)
