Description

Display a Windows (.hlp) or compiled HTML help file (.chm)

Return Type

None  

Syntax

object.ShowHelp [HelpFile], [Command], [Data]

The ShowHelp Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McApplication.
HelpFileOptional. A String value.

The .chm or .hlp file to display.

CommandOptional. A mcHelpCommand enumeration, as described in settings.

A command to run once the file is open (default to mchcDisplayTopic).

DataOptional. A Variant value.

A topic id when Command is mchcDisplayTopic.

Settings

The settings for Command are:

ConstantValueDescription
 mchcDisplayTopic0

Display a specific topic

 mchcDisplayTOC1

Display the table of contents

 mchcDisplayIndex2

Display the help index

 mchdShellOpen4

Open the help document with ShellExecute

Remarks

If HelpFile is not an absolute path, ShowHelp will look for it in the Help directory of the application folder.