Skip to content

CommonDialogHelpConstants Enumeration

Description

Help Dialog Constants.

Members

Member Description
xtpHelpCommandHelp Executes a Help macro.
xtpHelpContents 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.
xtpHelpContext Displays Help for a particular context. When using this setting, you must also specify a context using the HelpContext property.
xtpHelpContextPopup Displays in a pop-up window a particular Help topic identified by a context number defined in the [MAP] section of the .hpj file.
xtpHelpForceFile 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.
xtpHelpHelpOnHelp Displays Help for using the Help application itself.
xtpHelpIndex Displays the index of the specified Help file. An application should use this value only for a Help file with a single index.
xtpHelpKey Displays Help for a particular keyword. When using this setting, you must also specify a keyword using the HelpKey property.
xtpHelpPartialKey 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.
xtpHelpQuit Notifies the Help application that the specified Help file is no longer in use.
xtpHelpSetContents Determines which contents topic is displayed when a user presses the F1 key.
xtpHelpSetIndex 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 HelpCommand property uses values from the CommonDialogHelpConstants enumeration to specify the type of help.

See Also


Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.