OpenHelp Method

Opens a Windows Compiled HTML Help (.CHM) file. 

System.OpenHelp(HelpFile, Command[, Value])

Client support

   Newlook Smartclient only.

Parameters

HelpFile - (String, Required)

String value specifying the name (and optionally the path) of the .CHM file.

It is assumed that help files are located in the default Newlook solution folder, therefore any path specified must be relative to this location.

Command - (Integer, Required)

A constant specifying the command to execute. It should be one of the pre-defined Command constants.

Value - (Integer, Required)

Options for this parameter are no longer supported, specify 0 in this argument.

ClosedExamples

In the following example we are opening a specific page in the MyHelp.CHM file.

JSCRIPT

System.OpenHelp("MyHelp.chm::/MyPage.htm", nlHelpContents, 0);

VB SCRIPT

System.OpenHelp "MyHelp.chm::/MyPage.htm", nlHelpContents

Returns

No return value.

Applies To

System object

See Also

OpenHelp action | OpenHyperlink action | General Rules - Local Help Files

© 2004-2021 looksoftware. All rights reserved.