ToolTip (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage properties / Properties associated with windows, pages and controls

Specific features
Tooltip of a Tab control
Tooltip of a Radio Button and/or Check Box control
Tooltip associated with row of a TreeView control
Tooltip associated with a Table control and its columns
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ToolTip (Property)

In french: Bulle

The ToolTip property gets and sets the text displayed in a tooltip. This tooltip can be associated with:

a control in a window,
a control in a page,
New in SaaS
a control in a report. In this case, the tooltip will only be visible in the report viewer.
Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3.
For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.

Reminder: To enter the text displayed in the tooltip of a control in the window or page editor:

Open the control description window (select "Description" in the context menu).
On 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.
- If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be maintained at runtime.

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 tooltip text for the current element 
// in a TreeView control
TREE_DirectoryTreeView[TREE_DirectoryTreeView].ToolTip = "New tooltip"

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

// Change the tooltip text using an RTF file
EDT_TxtInput.ToolTip = fLoadText("C:\Temp\MyFile.RTF")

Syntax

Getting the tooltip text Hide the details

<Tooltip text> = <Control used>.ToolTip

<Tooltip text>: Character string

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

<Control used>: Control name

Name of the control for which you want to get the tooltip text.

Changing the tooltip text Hide the details

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

<Control used>: Control name

Name of the control for which you want to change the tooltip text.

<New tooltip text>: Character string

New tooltip text associated with the control. If this text is an empty string (""), no tooltip will be displayed.
This text can contain images and be formatted using the gXXX WLanguage functions.
This text can be in RTF (RTF file or text with RTF tags).

Remarks

Specific features

The ToolTip property can be 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.
End users can modify the tooltips in their applications. For more details, see Control tooltips (AAF).
The tooltip text can be displayed in a standard or custom tooltip. For more details, see Custom tooltips.

Tooltip of a Tab control

You can define a tooltip for each tab of a Tab control.

Tooltip of a Radio Button and/or Check Box control

You can define a tooltip for the control and for each of its options. For example:

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

Tooltip associated with row of a TreeView control

You can define a tooltip for each element o a TreeView control (TreeAdd, TreeInsert and TreeModify).

Tooltip associated with a Table control and its columns

You can define a tooltip for a Table control and for each of its columns. The tooltip of the Table control is displayed if you hover over a column that doesn't have a tooltip.

Limitations

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

The ToolTip property can only be used in the following controls:

Button control.
Static Text control.
Edit control.
Image control.
Check Box control.
Radio Button control.
List Box control.
Combo Box control.
TreeView control.
Tab control.
Table control.
Table control columns (Text, Combo Box or Check Box type).