Visual Basic: CommonDialog Control
HelpCommand Property
Returns or sets the type of online Help requested.
Syntax
object**.HelpCommand** [= value]
The HelpCommand property syntax has these parts:
| Part | Description |
| object | An object expression that evaluates to an object in the Applies To list. |
| value | A constant or value specifying the type of Help, as described in Settings. |
Settings
The settings for value are:
| Constant | Value | Description |
| cdlHelpCommand | &H102& | Executes a Help macro. |
| cdlHelpContents | &H3& | Displays the Help contents topic as defined by the Contents option in the [OPTION] section of the .hpj file. See Remarks below for information on Help files created with Microsoft Help Workshop 4.0X. |
| cdlHelpContext | &H1& | Displays Help for a particular context. When using this setting, you must also specify a context using the HelpContext property. |
| CdlHelpContextPopup | &H8& | Displays in a pop-up window a particular Help topic identified by a context number defined in the [MAP] section of the .hpj file. |
| cdlHelpForceFile | &H9& | Ensures WinHelp displays the correct Help file. If the correct Help file is currently displayed, no action occurs. If the incorrect Help file is displayed, WinHelp opens the correct file. |
| cdlHelpHelpOnHelp | &H4& | Displays Help for using the Help application itself. |
| cdlHelpIndex | &H3& | Displays the index of the specified Help file. An application should use this value only for a Help file with a single index. |
| cdlHelpKey | &H101& | Displays Help for a particular keyword. When using this setting, you must also specify a keyword using the HelpKey property. |
| cdlHelpPartialKey | &H105& | Displays the topic found in the keyword list that matches the keyword passed in the dwData parameter if there is one exact match. If more than one match exists, the Search dialog box with the topics found listed in the Go To list box is displayed. If no match exists, the Search dialog box is displayed. To bring up the Search dialog box without passing a keyword, use a long pointer to an empty string. |
| cdlHelpQuit | &H2& | Notifies the Help application that the specified Help file is no longer in use. |
| cdlHelpSetContents | &H5& | Determines which contents topic is displayed when a user presses the F1 key. |
| cdlHelpSetIndex | &H5& | Sets the context specified by the HelpContext property as the current index for the Help file specified by the HelpFile property. This index remains current until the user accesses a different Help file. Use this value only for Help files with more than one index. |
Remarks
The values for the HelpCommand property constants are listed in the Microsoft CommonDialog Control (MSComDlg) object library in the Object Browser.
The constant cdlHelpContents doesn't work for Help files created with Microsoft Help Workshop Version 4.0X. Instead, you use the value &HB to get the same effect. See the HelpCommand Property Example for a working code example.
Data Type
Integer