How to Enable the Help Button on a Modal Property Sheet

1.52    | 2.00 2.10 4.00

The information in this article applies to:

• The Microsoft Foundation Classes (MFC) included with:

      - Microsoft Visual C++ for Windows, version 1.52
      - Microsoft Visual C++, 32-bit Edition, versions 2.0, 2.1, and 4.0
  

SUMMARY

The F1-key help functionality and the Help button on a Modal Property sheet can be enabled by choosing Context-Sensitive Help while generating an AppWizard-generated application. In a standard AppWizard-generated application, clicking the Help button on the property sheet has no effect because there is no default handler for the Help button. This article shows by example how to obtain F1-key functionality with the Help button.

MORE INFORMATION

Step-by-Step Example

The default implementation of a modal property sheet has no handler for the Help button. To obtain F1-key functionality with the Help button, follow these steps:

1. Derive a class from CPropertySheet.

2. Add an OnHelp handler for ID_HELP to the property sheet. For more information on how to add a handler, please see MFC Technical Note #6.

3. In the OnHelp handler, send a WM_COMMANDHELP message to the property sheet window by using SendMessage(WM_COMMANDHELP).

4. Implement the following code to provide the Help button with context-sensitive help functionality of the F1 function key:

      // Derive a class CMyPropertySheet from CPropertySheet.
      // Include the file afxpriv.h to obtain the id for
      // WM_COMMANDHELP in the implementation file for CMyPropertySheet
   
      #include "afxpriv.h"
   
      // add this handler in the implementation file for CMyPropertySheet
   
      void CMyPropertySheet::OnHelp( )
      {
           SendMessage(WM_COMMANDHELP);
      }
   
   

REFERENCES

Please see the DLGPROP.CPP file in the MFC\SRC subdirectory of the Visual C++ installation or distribution CD directory. This source file includes source code for CPropertySheet and CPropertyPage.