ToolTip

Creates an always-on-top window anywhere on the screen.

ToolTip Text, X, Y, WhichToolTip

Parameters

Text

Type: String

If blank or omitted, the existing tooltip (if any) will be hidden. Otherwise, this parameter is the text to display in the tooltip. To create a multi-line tooltip, use the linefeed character (`n) in between each line, e.g. Line1`nLine2.

If Text is long, it can be broken up into several shorter lines by means of a continuation section, which might improve readability and maintainability.

X, Y

Type: Integer

The X and Y position of the tooltip relative to the active window (use CoordMode "ToolTip" to change to screen coordinates). If the coordinates are omitted, the tooltip will be shown near the mouse cursor.

WhichToolTip

Type: Integer

Omit this parameter if you don't need multiple tooltips to appear simultaneously. Otherwise, this is a number between 1 and 20 to indicate which tooltip window to operate upon. If unspecified, that number is 1 (the first).

Return Value

Type: Integer or empty string

If a tooltip is being shown or updated, this function returns the tooltip window's unique ID (HWND), which can be used to move the tooltip or send Tooltip Control Messages.

If Text is omitted or blank, the return value is an empty string.

Remarks

A tooltip usually looks like this: ToolTip

If the X & Y coordinates caused the tooltip to run off-screen, or outside the monitor's working area on Windows 8 or later, it is repositioned to be entirely visible.

The tooltip is displayed until one of the following occurs:

A GUI window may be made the owner of a tooltip by means of the OwnDialogs option. Such a tooltip is automatically destroyed when its owner is destroyed.

CoordMode, TrayTip, GUI, MsgBox, InputBox, FileSelect, DirSelect

Examples

Shows a multiline tooltip at a specific position in the active window.

ToolTip "Multiline`nTooltip", 100, 150

Hides a tooltip after a certain amount of time without having to use Sleep (which would stop the current thread).

ToolTip "Timed ToolTip`nThis will be displayed for 5 seconds."
SetTimer () => ToolTip(), -5000