SAMPLE: Context-Sensitive Help in a CDialog Object

 Last reviewed: July 2, 1997
Article ID: Q141724
The information in this article applies to:
  • The Microsoft Foundation Classes (MFC) included with: - Microsoft Visual C++, 32-bit Edition, versions 4.0, 4.1 4.2, 4.2b, 5.0

This is the 32-bit version of this sample.

SUMMARY

The DLGHLP sample illustrates implementing context-sensitive help in a CDialog object.

The following file is available for download from the Microsoft Software Library: 

 ~ Dlghlp32.exe (size: 62368 bytes)
For more information about downloading files from the Microsoft Software Library, please see the following article in the Microsoft Knowledge Base: 

   ARTICLE-ID: Q119591
   TITLE     : How to Obtain Microsoft Support Files from Online Services
Dlghlp32.exe was archived as a self-extracting file using the PKware file- compression utility. The archived file contains subdirectories, and therefore, the -d switch needs to be used when decompressing the file to disk.

MORE INFORMATION

The DLGHLP32 sample implements context-sensitive help in a dialog box by overriding CWnd::OnHelpInfo and CWnd::OnContextMenu in the dialog class to handle the WM_HELP and WM_CONTEXTMENU messages. WM_HELP and WM_CONTEXTMENU are new Win32 messages that are received by the active window when Help is requested. DLGHLP32 uses the information provided to these handlers to call ::WinHelp with the appropriate parameters.

DLGHLP32 includes two dialog boxes, each with a number of controls in them. The user is able to set the focus to a particular control and, by pressing F1, right-clicking, or using the ? (question mark) icon to bring up help that is specific for that control. Several of the control IDs are used in both dialog boxes. For example, each dialog box contains a radio button with the ID of IDC_RADIO1. To allow a unique help context value to be generated for each control, the ID of each dialog box is used as a base and is added to the ID of the control.

::WinHelp provides two new help commands for handling WM_HELP and WM_CONTEXTMENU. They are HELP_WM_HELP and HELP_CONTEXTMENU, respectively. In both cases, an array mapping control IDs to help contexts is passed in the dwData parameter. DLGHLP32 defines two of these arrays, one for each dialog box class. This facilitates generating unique help context for controls in both dialogs, even if the control IDs are the same.

DLGHLP32 is based on an AppWizard-generated application. Files included with the sample which are directly related to implementing context- sensitive help in a dialog box are:

  • DLGBOX1.CPP: Implements context-sensitive help for Dialog Box 1 by overriding CWnd::OnHelpInfo and CWnd::OnContextMenu.
  • DLGBOX2.CPP: Implements context-sensitive help for Dialog Box 2 by overriding CWnd::OnHelpInfo and CWnd::OnContextMenu.
  • DLGRES.H: Defines the help context IDs based on the ID of the dialog box and the specific control.
  • DLGCTRLS.HM: Help map file that defines the help context IDs for the dialog box controls.

Additional query words: DLGHLP context sensitive
Keywords : kbfile kbprg kbsample MfcUI
Technology : kbMfc
Version : 4.0 4.1 4.2 4.2b 5.0
Platform : NT WINDOWS
Resolution Type : kbcode

THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: July 2, 1997
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.