Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » Node » Group » ConfigNode » HelpConfigNode |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| string | GetHelpAttrib | Returns the HelpConfigNode string at the specified index. The index refers to the HelpAttribIndex enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | SetHelpAttrib | Sets the help attribute string at the specified index. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| string | Author | Gets or sets the author string. |
| string | CompanyName | Gets or sets the company name string. |
| string | CompanyURL | Gets or sets the company URL string. |
| string | HelpAddress | Gets or sets the help address string, which is the path or URL to the help on a local machine. For example: C:\MyHelp\Help.htm or http://127.0.0.1/help/help.stm. |
| string | HelpIndexFile | Gets or sets the help index file path, which is the absolute or relative path to the HTML document containing the tree view used to navigate the help. If relative, this path should be relative to server root path, and should not be relative to the document. |
| string | HelpTitle | Gets or sets the string used to set the HTML <title> value. |
| string | ModuleCreator | Gets or sets the module creator, which is usually the same as the company name ( but may refer to a specific author at the company ). |
| string | RemoteServerRoot | The root of a remote web server where you wish to upload the help. For example, many hosting services provide a directory such as D:\Customer or C:\User or C:\Webroot. In each of these cases, the value of the remote server root is "Customer", "User", or "Webroot" ( case insensitive ). This may vary ( or not apply ) for content hosted over a local area network, and is generally only applicable in cases where the upload commands are used to copy content onto a remote server via FTP script. |
| string | ScriptExternalDocs | Deprecated. |
| string | ScriptOutputDocs | Deprecated. |
| string | ServerRoot | An absolute or relative path to the help on the local drive. This path should be relative to the document location. For example, if your help is stored at C:\MyHelp\Help and your help document data is stored at C:\MyProject\MyHelp\Help.box, then the relative path is "..\..\MyHelp\Help". |