IntelliCAD 11.1 Object Library | |
Help Method | |
See Also |
- HelpFile
- A string variable representing the name of the help file.
- HelpTopic
- A string variable representing the name of the help topic.
- HelpCommand
- A .long-integer variable representing the name of the help command. It is defined in winuser.h and can be HELP_CONTENTS, HELP_HELPONHELP or HELP_PARTIALKEY.
Application Object : Help Method |
Description
Syntax
Visual Basic |
---|
Public Sub Help( _ ByVal HelpFile As String, _ Optional ByVal HelpTopic As String = "", _ Optional ByVal HelpCommand As Long = 0 _ ) |
Parameters
- HelpFile
- A string variable representing the name of the help file.
- HelpTopic
- A string variable representing the name of the help topic.
- HelpCommand
- A .long-integer variable representing the name of the help command. It is defined in winuser.h and can be HELP_CONTENTS, HELP_HELPONHELP or HELP_PARTIALKEY.
Remarks
Intellicad will search for the file in all known locations (as defined by the search path). If the hlp file is not found, this method will fail. You can also provide the full path to the help file in which case, this method will succeed. Using the 2nd and 3rd optional arguments, you can bring up help on a specific topic. The following constants are defined in winuser.h (a Windows system file).
#define HELP_CONTENTS 0x0003L
#define HELP_HELPONHELP 0x0004L /* Display help on using help */
#define HELP_PARTIALKEY 0x0105L
In VBA:
Call Application.Help("icadvba.hlp", "Colors", 261)
This will bring up the Colors topic. Note that 261 is HELP_PARTIALKEY(0x0105) in decimal
Call Application.Help("icadvba.hlp", , 3)
will bring up the contents
Call Application.Help("icadvba.hlp", , 4)
will bring up help on help.
Example
To simply bring up help, you can use this method with no optional parameters as follows: