PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

  • Context-sensitive help
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
HelpFile (Function)
In French: FichierAide
Returns or modifies the name of the help file used by the context-sensitive help of a window.
Example
// Use the "D:\WINDEV\Help\Help.chm" help file
// for the context-sensitive help of "WIN_Window1"
HelpFile(WIN_Window1, "D:\WINDEV\Help\Help.chm")
// Use the "Help.hlp" help file
// for the context-sensitive help of the current window
HelpFile("", "Help.hlp")
// Find out the help file used
// for the context-sensitive help of the current window
ResHelpFile = HelpFile("")
Syntax

Finding out the name of help file used for the context-sensitive help Hide the details

<Result> = HelpFile(<Window Name>)
<Result>: Character string
Name and path of help file (.HLP or .CHM) associated with the window for the context-sensitive help.
<Window Name>: Character string (with or without quotes)
Name of window whose associated help file is requested. If this parameter corresponds to an empty string (""), the window used is the window to which the current process belongs.

Modifying the help file used for the context-sensitive help Hide the details

<Result> = HelpFile(<Window Name> [, <Name of Help File>])
<Result>: Character string
Name and path of help file (.HLP or .CHM) associated with the window for the context-sensitive help before modification.
<Window Name>: Character string (with or without quotes)
Name of window used. If this parameter corresponds to an empty string (""), the window used is the window to which the current process belongs.
<Name of Help File>: Optional character string (with quotes)
Name and path of help file (.HLP or .CHM) used for the context-sensitive help. A relative path or a UNC path can be used.
Remarks

Context-sensitive help

The context-sensitive help is displayed when the user clicks the "What is it" icon in the window (? icon).
This context-sensitive help is based:
  • On the window style ("Icon of context-sensitive help" checked).
  • On the file for context-sensitive help defined:
    • in the window editor ("Help" tab in the description window of window).
    • by HelpFile.
  • On the help number defined in the control description.
Components
WINDEVReports and Queries wd230obj.dll
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment