CGenerator Class
The CGenerator class of the iNavigate.dll has the Properties, Methods and Events described below using Visual Basic syntax.
Please refer to the ActiveX demo application for an example of the use of these interfaces.
|
 |
INIFile Property
Returns or sets a value, which is the name of the INI file, used by iNavigate for generation. The default INI file is iNavigate.INI colocated with the iNavigate.DLL file.
object.INIFile [= string]
The INIFile Property syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| string |
A string expression, which is the name of the INI file to be used by iNavigate for generation. |
|
 |
XMLFile Property
Returns or sets a value, which is the name of the XML file, used by iNavigate for generation. Must be set before calling BeginBatch.
object.XMLFile [= string]
The XMLFile Property syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| string |
A string expression, which is the name of the XML file to be used by iNavigate for generation. |
|
 |
BeginBatch Method
Prepares iNavigate for generation of a batch or one or more HTML files using Generate. Causes specified INIFile and XMLFile to be parsed and loaded. Must be called before calling Generate.
object.BeginBatch
The BeginBatch Method syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
|
 |
EndBatch Method
Concludes iNavigate generation of a batch or one or more HTML files using Generate. Causes specified INIFile and XMLFile to be unloaded. Summary statistical information is reported via Message Event.
object.EndBatch
The EndBatch Method syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
|
 |
Generate Method
Requests the generation of a specified HTML file. The specified HTML File must be defined in the XMLFile as being associated with a menu item, or as an index or menu file in frames mode. BeginBatch must be called before calling Generate.
object.Generate HTMLFile
The Generate Method syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| HTMLFile |
A string expression, which is the name of the HTML file to be generated. |
|
 |
ErrorMessage Event
Occurs to notify the calling application of a error condition during the generation.
Private Sub object_ErrorMessage (Message As String)
The ErrorMessage Event syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| Message |
A string containing the text of the Error Message. |
|
 |
Message Event
Occurs to notify the calling application of a informational message during the generation.
Private Sub object_Message (Message As String)
The Message Event syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| Message |
A string containing the text of the Message. |
|
 |
WarningMessage Event
Occurs to notify the calling application of a warning condition during the generation.
Private Sub object_WarningMessage (Message As String)
The WarningMessage Event syntax has these parts.
| Part |
Description |
| object |
An object expression that evaluates to an instance of the iNavigate CGenerator Class. |
| Message |
A string containing the text of the Warning Message. |
|