Description
Displays help text for tools.
-
Return Type
-
None
-
Syntax
-
object.SetToolHelp [Text], [Title], [Module], [Flags], [HelpContext], [HelpFile]
The SetToolHelp Method syntax has these parts: |
| object | An expression evaluating to an object of type McApplication. | | Text | Optional. A String value. The help message to display.
| | Title | Optional. A String value. A title for the help window (not used).
| | Module | Optional. A String value. Module used when calling LocalizeString.
| | Flags | Optional. A mcToolHelpFlags enumeration, as described in settings. Localize Text and Title if set to mcthfLocalize.
| | HelpContext | Optional. A Long value. The topic id for additional help information (not used).
| | HelpFile | Optional. A String value. The help file for additional help information (not used).
|
Settings The settings for Flags are:
|
 | mcthfLocalize | 1 |
Localize the Text passed to SetToolHelp before displaying it.
|
| mcthfRTF | 2 |
SetToolHelp Text parameter contains RTF text.
|
Remarks
The current implementation for this method calls LocalizeString(Text,Module), then display Text in the first Pane of StatusBar. Future implementations will use the other parameters to create popup help windows.
|
SetToolHelp Method
