peHelpType - cApplication

Determines which type of help system is used by the program

Type: Property

Access: Read/Write

Data Type: Integer

Parameters: None

Syntax
 Property Integer peHelpType

Read Access: Get peHelpType to IntegerVariable
Write Access: Set peHelpType to IntegerVariable/Value


Description

The framework can work with different help systems. When the help system is invoked, the framework searches for the Help_Id property of the focussed object in the relevant helpfile.

Set the property to one of the following constants:

ConstantMeaning
htNoHelp (0)No help system is being used.
htHtmlHelp (1)A HTML help system is being used
htWinHelp (2)A WinHelp help system is being used (OBSOLETE)

Note:In addition to setting this property, you should also set the psHelpFile property to the name of the file containing your help.



Windows Help is obsolete. You are encouraged to build an HTML based help system.

While the class default is htWinHelp, when you create a new Windows project or Windows test project in the studio, it defaults to htHtmlHelp, which is a more modern and appropriate default.

See Also

psHelpFile