ToolTip (Property)

The ToolTip property is used to insert images and colored text into the tooltip via the gXXX functions.
The ToolTip property allows you to insert RTF content in tooltips.
Versions 21 and later
End users can modify the tooltips in their applications. For more details, see Control tooltips (AAF).
New in version 21
End users can modify the tooltips in their applications. For more details, see Control tooltips (AAF).
End users can modify the tooltips in their applications. For more details, see Control tooltips (AAF).
Versions 26 and later
The tooltip text can be displayed in a standard or custom tooltip. For more details, see Custom tooltips.
New in version 26
The tooltip text can be displayed in a standard or custom tooltip. For more details, see Custom tooltips.
The tooltip text can be displayed in a standard or custom tooltip. For more details, see Custom tooltips.

Reminder: To type the message displayed in the tooltip of a control in the editor:

Open the control description window (select "Description" in the context menu).
In the "Help" tab, in the "Tooltip" area, type the text of the tooltip.
Remarks:
- In a multilingual application, the text of the tooltip can be typed in several languages.
- Versions 21 and later
  If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at runtime.
  New in version 21
  If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at runtime.
  If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at runtime.

Versions 18 and later

This property is now available in Windows Store Apps mode.

New in version 18

This property is now available in Windows Store Apps mode.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Example

// Change the tooltip text according to the type of user
IF User_Type = 0 THEN
EDT_Name.ToolTip = "Type the customer name"
ELSE
EDT_Name.ToolTip = "Customer name"
END

// Change the text of the tooltip for the current element
// in a TreeView control
TREE_DirectoryTreeView[TREE_DirectoryTreeView].ToolTip = "New tooltip"

// Change the tooltip text by using the gXXX functions
// in an edit control
EDT_TxtInput.ToolTip = gPen(LightRed) + ...
gFont("Comic sans MS") + ...
gFontUnderlined(True) + ...
"Run the test of tooltips with the gXXX functions" + ...
CR + gImage("small dog.gif") + "TEST" + gFontBold(True) + "TEST"

// Change the text of the tooltip by using a file in RTF format
EDT_TxtInput.ToolTip = fLoadText("C:\Temp\MyFileRTF")

Syntax

Finding out the text of the tooltip Hide the details

<Tooltip text> = <Control used>.ToolTip

<Tooltip text>: Character string

Current text of tooltip associated with the control.
Remark: If the text of the tooltip is in RTF, the text returned will contain the RTF tags.

<Control used>: Control name

Name of the control for which the text of the tooltip is requested.

Modifying the text of the tooltip Hide the details

<Control used>.ToolTip = <New tooltip text>

<Control used>: Control name

Name of the control for which the text of the tooltip must be modified.

<New tooltip text>: Character string

New text for the tooltip associated with the control. If this text corresponds to an empty string (""), no tooltip will be displayed for this control.
This text can contain images and it can be formatted by using the gXXX functions of WLanguage.
This text can correspond to a RTF text (RTF file or text with RTF tags).

Remarks

Tooltip of a Tab control

For the Tab controls, a tooltip can be defined for each one of the tab panes.

Tooltip associated with a Radio Button and/or Check Box control

A tooltip can be defined for the control and for each option. For example:

RADIO_MyRadioButton[1].ToolTip = "Option #1"

Tooltip associated with row in a Treeview control

For the TreeView controls, a tooltip can be defined for each one of the treeview elements (TreeAdd, TreeInsert and TreeModify).

Tooltip associated with a Table control and with a column in a Table control

The window editor allows you to define a tooltip for a Table control and for each one of its columns. The tooltip associated with the Table control is displayed if no tooltip was defined for the column hovered by the mouse cursor.

Limitations

The ToolTip property applies only to windows and controls in a window (including columns and cells in a table). This property cannot be used with menus.

The ToolTip property applies only to the following controls:

Button control.
Static control.
Edit control.
Image control.
Check Box control.
Radio Button control.
List Box control.
Combo Box control.
TreeView control.
Tab control.
Table control.
Table column control (text, combo box or check box type).