ToolTip

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

ToolTip Text, X, Y, WhichToolTip

Parameters

Text

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

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

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).

Remarks

If the X & Y coordinates would cause the tooltip to run off screen, it is repositioned to be entirely visible.

The tooltip is displayed until one of the following occurs:

• The script terminates.
• The ToolTip function is executed again with a blank Text parameter.
• The user clicks on the tooltip (this behavior may vary depending on operating system version).

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.

Related

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

Example

ToolTip "Multiline`nTooltip", 100, 150

; To have a ToolTip disappear after a certain amount of time
; without having to use Sleep (which stops the current thread):
ToolTip "Timed ToolTip`nThis will be displayed for 5 seconds."
SetTimer "RemoveToolTip", -5000
return

RemoveToolTip:
ToolTip
return