WinTooltipCtrl

(Engine-Level Function)

Description: Windows native "tooltip" control. A "tooltip" is a pop-up text window that provides operational hints to users when the mouse pointer is rested over a tool or object.
Returns: Invalid
Usage: Steady State only.
Function Groups: Graphics,  Locator
Related to: WindowOptions
Format: WinTooltipCtrl(X0, Y0, X1, Y1, Style, Text [, Title, IconIndex, Enable, Font])
Parameters:  
X0, Y0, X1, and Y1   
Required. Coordinates of a rectangular screen area. When the mouse enters that area (the "hit area"), and stops moving for a time, the pop-up tooltip will be displayed.
Style   
Required. One or more of the following bit flags, used to control the style of the tooltip:
  • 1 - If set, the tooltip will respond to the mouse in the hit area regardless as to whether the containing window is the active window. If clear (default), the tooltip only responds if it is the active window.
  • 32 - If set, fading of the tooltip is disabled. If clear (default), the tooltip fades in and (under some circumstances) out.
  • 64 - If set, the tooltip is displayed as a balloon. If clear (default), the tooltip is displayed as a rectangular window.
  • 128 - If set, the tooltip is displayed in-place (i.e. over the top of the hit area). This is most useful when the hit area is occupied by clipped text and the tooltip contains the full text, so that hovering over the clipped text shows the full text in a tooltip window positioned over the top of the clipped text. Note: System.ListBox uses this ability.

(See: Bitwise Parameters & Operations)
Text   
Required. Any expression yielding a simple text value or a 1-dimensional array of text values. If this yields a simple text value, the text value is displayed in the tooltip control, interpreting any carriage return/line feed pairs (CRLF) as a line break, causing what follows to display on the following line. If this yields an array, each element of the array is displayed in a new line of the tooltip control. Text is limited to 1000 characters.
Title   

An optional parameter that can be any expression yielding a simple text value. The text value is displayed in the tooltip control as a title (emboldened at the top of the tooltip).

Titles are limited to 100 characters. Windows will blank any tool tip title longer than 100 characters.
IconIndex   
Selects an optional icon to display to the left of the title:

Invalid or 0 - No Icon

1 - Information Icon

2 - Warning Icon

3 - Error Icon

Note that while the operating system may define other icons for other values of this parameter, these are not defined at the present, and are hence subject to change.
Enable  
An optional parameter that if non-zero enables the popping-up of the tooltip. If Invalid, the default is true (i.e. pop-up enabled).
Font   

An optional parameter that can be set to a font value for the font to be used by the tooltip. If Invalid, the default system font is used.

Note that underlining is not supported.
Comments: This statement returns Invalid.
The background color, text color, and delay timings are set on a per-window basis using the WindowOptions statement.

Detailed information about native Windows tooltip support is provided in "Common Tasks: Native Windows Tooltip Support".