Skip to content

psHelpFile - HelpSystem

Assigns a help file name within the help object (not normally used)

Type: Property
Access: Read/Write
Data Type: String
Parameters: None

Syntax

Property String psHelpFile
Access Type Syntax
Read Access: Get psHelpFile to StringVariable
Write Access: Set psHelpFile to StringVariable/Value

Description

The psHelpFile property assigns a help file name within the help object (not normally used).

When the help object opens a help file it uses the following logic to find a help file:

  1. If psHelpFile is set, it uses that name. Normally, this property will not be set.

  2. If psHelpFile is blank, it checks to see if the cApplication object exists and if it does, if it has a psHelpFile name set. If so, this name is used. This is the preferred place to set your help file name.

  3. If no help file exists, the help system uses the old private help name which gets the full name from the registry. This last method is considered obsolete (and far too complicated).

It is always recommended that you set the help file name in the cApplication object.

If psHelpFile is used here or in the cApplication object, the property should contain just the filename and extension. The help system will attempt to find the file in an appropriate workspace path.