This class holds Help Builder's Configuration settings. These settings determine how the Help Builder User Interface works and it also holds common settings from the currently active Help Builder Project file.
The Config object is accessible only through the wwHelpForm interface, not from the base wwHelp object.
To access the config object usually looks like this:
oHelp = CREATEOBJECT("wwhelp.wwhelp")
oHelp.OpenForm("",0)
oConfig = oHelp.oForm.oConfig
The object will be loaded up so no manual loading is required under usual circumstances.
The Help Builder Form writes out and calls the Save() method when it is shutting down to save it's last access state (last topic, last position etc.).
Class Members
Member | Description | |
---|---|---|
Load |
Loads the content of the wwhelp.ini file into the class properties. o.Load(loObject) |
|
Save |
Saves the content of the class into the wwhelp.ini file. o.Save(loObject) |
|
cappname |
The name of the Help Project | |
cclassopenpath |
Path where a class was last opened. Used to set the path there for the next class open. | |
ccodefont |
The font used for Code View (Courier New, 10 pt normally). | |
ceditfont |
The font used in plain edit boxes in Help Builder. Default (Verdana, 10pt) | |
ceventobjectprogid |
ProgID for a COM object that can handle special event hooks that fire when various operations occur inside of Help Builder. | |
cFilename |
Name of the currently open help file. This is just the filename without the path. | |
cHelpWorkshopPath |
Path to Microsoft HTML Help Workshop - this location contains the Help Compiler. | |
cLastClassImportType |
Remembers the last | |
clastimagepath |
Last location an image was opened from | |
clasttopic |
The last topic that was displayed in Help Builder before shutting down. | |
cltag |
Right HTML markup tag for formatted HTML. | |
cMode |
Stock Settings | |
coutputpath |
Output path where HTML files are generated to - generally this will be the project path. | |
cprojectopenpath |
Saves the path where a project was last opened. | |
cRecentList |
A list of the recently accessed projects. The list is separated with | (pipe) characters. | |
crtag |
Right HTML markup tag for formatted HTML. | |
ctemplateeditor |
Editor program used for editing HTML templates. | |
dLastBackup |
Date of the last automatic backup of Help Builder. | |
dLastVersionCheck |
Date when the last version check was performed. | |
lautosavetopics |
Determines whether topics need to be manually saved or saved automatically when the topic is moved in any way. | |
lshowhelpcontextid |
If .T. the treeview shows the Help ContextId. | |
nmaxrecent |
The number of recently used projects displayed on the Open menu. | |
nviewmode |
Last view mode of hte form. 0 - Edit mode, 1 - Browser mode. |
© West Wind Techologies, 1996-2023 • Updated: 08/16/15
Comment or report problem with topic