Help / Editors / Help editor
  • Overview
  • The tooltips
  • The status bar
  • The standard help windows
  • CHM help file
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
There are multiple solutions to provide help to the users:
The first three types of help systems are directly created in the window editor, in the description of each control ("Help" tab). These help systems have a simple presentation and cannot be linked together.
The fourth type of help system is created in the help editor. It is a more structured help system, allowing you to guide the users step by step.
The tooltips
The tooltips are light yellow rectangles that are displayed when a control is hovered by the mouse cursor. A tooltip contains a help message about the hovered control. A tooltip can inform the user about the expected currency unit when typing a price, for example.
By default, the tooltips are automatically enabled in a WINDEV application.
To type the message to be displayed in the tooltip of a control:
  1. Open the control description window (select "Description" in the context menu).
  2. In the "Help" tab, in the "Tooltip" area, type the text of the tooltip.
  3. Validate.
  • In a multilingual application, you can enter the text of the tooltip in several languages, in the description window of the control.
  • 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.
  • The text of the tooltip can be modified programmatically with the ToolTip property.
  • The tooltip automatically applies a margin around the text: therefore, the text of the tooltip is more readable.
  • End users can modify the tooltips in their applications. For more details, see Control tooltips (AAF).
For more details on how to customize tooltips, see Custom tooltips.
The status bar
You can display information in the status bar of a window. There are two cases:
  • The message is linked to a control. The message can be entered in the "Help" tab of the description window of the controls. The message will be displayed when the control is selected by the user.
  • The message is linked to a process defined programmatically. Simply use Message to specify the message to display.
Status bar
For more details on status bars, see Status bar of windows.
The standard help windows
The standard help windows are standard "Windows" windows used to display an explanatory text associated with a control.
The title and text of this type of window can be entered in the "Help" tab of the control description window. No image can be used in these windows.
Standard help
If this window was defined for a control, the window will be automatically displayed when pressing the F1 key.
CHM help file
A help system includes a summary, keywords (index) and pages. When users open the help, they are taken to a help page. Help pages can contain images, links to other pages, etc
In WINDEV, you can create CHM help files:
CHM help file
There are several ways to launch this help:
  • full help: the help file is displayed directly.
  • full context-sensitive help: the help file is opened on a specific page corresponding to the current window or control.
For more details on how to create a help file, see Creating a help file.
For more details on the different ways to open a CHM file, see Starting the help.
Related Examples:
Help for the user Unit examples (WINDEV): Help for the user
[ + ] Using messages and tooltips to simplify the work of the application users.
BalloonTip Unit examples (WINDEV): BalloonTip
[ + ] Displaying BalloonTip.
A BalloonTip is an advanced tooltip. In most cases, this BalloonTip is displayed above an icon in the taskbar.
A BalloonTip is used to display an information to the user without interrupting his work (when the application is in background or when it is minimized in the Windows "Systray" for example).
Unlike the dialog boxes displayed by the WLanguage functions such as Info, Warning or Error, a BalloonTip is not locking. It is used to display messages whose importance and type can be configured.
A BalloonTip contains:
- an icon used to identify the type of message
- a title
- a "Close" button
- a specific message.
Minimum version required
  • Version 9
Click [Add] to post a comment

Last update: 06/26/2023

Send a report | Local help