WinHelp

  • Article

Displays a WinHelp topic in the WinHelp primary window, a WinHelp secondary window, or in a WinHelp pop-up window. The specific window attributes, such as size and position, background color, and button bar items, are based on the definitions in the [WINDOWS] section of the specified WinHelp project (.hpj) file.

This command can be used only with a compiled help (.chm) file.

Syntax

<PARAM  name="Command" value="WinHelp [,Popup]>
<PARAM  name="Item2"   value="<i>topic ID</i>|<i>map number</i>">
<PARAM  name="Item1"   value="<i>WinHelp (.hlp) file path</i> [><i>window name</i>]">
[<PARAM name="Button"  value="[Text: <i>Button text</i>|Bitmap: <i>Bitmap file path</i>|Icon:<i>Icon file path</i>]">]
[<PARAM name="Font"    value="<i>Facename[, point size[, charset[, color[, PLAIN BOLD ITALIC UNDERLINE]]]]</i>">]
[<PARAM name="Text"    value="Text: <i>Link text</i>">]

Properties

Button

Specifies the button style. Optional.

Command

Calls the WinHelp command and specifies a WinHelp window type.

  • To display a pop-up WinHelp window, type Popup.
  • To display a secondary WinHelp window, do not specify a window type and specify a window name in the Item1 parameter.
  • To display the WinHelp main window, do not specify a window type or a window name (in the Item1 parameter).

Font

Specifies the font attributes. Optional.

Item1

Specifies the file path of the WinHelp (.hlp) file in which the WinHelp topic is stored, and the window name of the target window.

The window name must be preceded by the ">" character.

Do not specify a window name if you typed Popup in the Command parameter or if you want the topic to appear in the WinHelp main window.

Item2

Specifies the topic ID or map number of the WinHelp topic to display.

Text

Specifies the link text. Optional.

Example

<OBJECT
   id=winhelp
   type="application/x-oleobject"
   classid="clsid:52a2aaae-085d-4187-97ea-8c30db990436"
   codebase="hhctrl.ocx#Version=5,02,3790,1194"
   width=100
   height=100
>
   <PARAM name="Command" value="WinHelp">
   <PARAM name="Button" value="Text: Candomble Overview">
   <PARAM name="Item1" value="c:\winhelp\candomble_wh.hlp>MyWindow">
   <PARAM name="Item2" value="myth_candomble_overview">
</OBJECT>

Remarks

  • The Button parameter is omitted when this command is invoked by a script.

About Commands