ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Editors / Help editor
  • Overview
  • Opening a full help
  • Opening the help of a window or control
  • Opening the help of a window
  • Opening the help of a control
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
There are several ways to open a help file:
  • opening a full help: used to open the help file (displays the summary).
    In most cases, this operation is performed from a menu option (such as "?.. General help").
  • opening the help for a window or a control in the application: used to open the help file on a specific page. This page presents the different options available in the window or control.
    In most cases, this operation is performed via the F1 key or via a help button specific to the window.
Opening a full help
The help is opened by WHelp. Simply specify the name of the help file to open. The help file opens on the first page of the help defined during the compilation.
For example:
// Open a CHM help file
WHelp("MyChmHelp.chm")
// Opening the help in a multilingual application
WHelp("MyHelp" + Nation() + ".chm")
Opening the help of a window or control

Opening the help of a window

To open the help page of a window, use WHelp and specify the identifier of the desired page. This identifier was defined when creating the help system (in the characteristics of the page).
Remark: To automatically create the help button used to display the page corresponding to a window, Drag and Drop the relevant help page to the requested window.
The following example opens the help page of the "WIN_Configuration_Imp" window. The identifier of this help page is set to 5.
// Open a CHM help file
WHelp("MyChmHelp.chm", 5)

Opening the help of a control

To open the help page of a control:
  1. Specify the number of the page associated with the control in the control description ("Help" tab, "Help number" control).
  2. Use WHelp associated with NumHelp to open the help page (via a help button for example).
The following example presents the code of a help button. This button opens the help page associated with the control being edited.
// -- Code of Help button
WHelp("MyHelp.chm", NumHelp(ControlCurrent()))
Minimum version required
  • Version 9
Comments
Click [Add] to post a comment

Last update: 05/24/2023

Send a report | Local help