PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Overview
  • The tooltips
  • Status bar
  • The standard help windows
  • The help in HLP or CHM format
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The different types of help systems in a WINDEV application
Overview
Several solutions are available 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 they cannot be linked among themselves.
The fourth type of help system is created in the help editor. It produces a more structured help system, allowing you to guide the users step by step.
Windows Mobile Note: Only the tooltips and the information displayed in the status bar are available.
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 regarding the hovered control. A tooltip can inform the user of the expected currency when entering a price for example.
By default, the tooltips are automatically enabled in a WINDEV application.
To type the message displayed in the tooltip of a control:
  1. Display the description window of control ("Description" from the popup menu).
  2. In the "Help" tab, in the "Tooltip" area, type the text of the tooltip.
    Notes:
    • In a multilingual application, the text of the tooltip can be typed in several languages.
    • Versions 21 and later
      Windows If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at run time.
      New in version 21
      Windows If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at run time.
      Windows If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be respected at run time.
Notes:
  • The text of the tooltip can be modified by programming with ..ToolTip.
  • Versions 21 and later
    From version 21, a margin is displayed around the text: therefore, the tooltip text is more readable.
    New in version 21
    From version 21, a margin is displayed around the text: therefore, the tooltip text is more readable.
    From version 21, a margin is displayed around the text: therefore, the tooltip text is more readable.
  • Versions 21 and later
    Windows The end user can modify the tooltips found in his application. See Tooltip of controls (AAF) for more details.
    New in version 21
    Windows The end user can modify the tooltips found in his application. See Tooltip of controls (AAF) for more details.
    Windows The end user can modify the tooltips found in his application. See Tooltip of controls (AAF) for more details.
Status bar
When a window contains a status bar, information can be displayed in this status bar. Two possibilities:
  • 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 performed by programming. To do so, use Message to specify the message to display.
See Status bar of windows for more details.
The standard help windows
Windows The standard help windows are standard "Windows" windows used to display an explanatory text associated with a control.
This title of this window and its message are entered in the "Help" tab of the description window of the controls. No image can be used in these windows.
If this window was defined for a control, the window will be automatically displayed when pressing the F1 key.
The help in HLP or CHM format
Windows A help system includes a summary, keywords (index) and pages. When the user consults the help, he reads the content of a help page. These pages can contain images, links to other pages, ...
Two formats of help systems can be created in WINDEV:
  • help in HLP format:
  • help in CHM format:
This help system can be started according to three methods:
  • full help: the help file is displayed directly.
  • full context-sensitive help: the help file is started on a specific page corresponding to the current window or control.
  • graphic tooltip: the help is displayed as a context-sensitive tooltip.
    For example: Context-sensitive help
For more details, see: Creating a help file.
See Starting the help for more details.
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.
Help for the user Unit examples (WINDEV Mobile): 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 required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment