Referencing a compiled help file

If you have a compiled help file (.chm), your tools can reference it. A compiled help file is used when viewing the tool reference page.

By providing the help context (the HTML topic ID), when the user right-clicks a tool, then clicks Help, the help topic associated with the help context ID in the .chm file will be displayed.

If you do not supply a help context ID or supply an incorrect one, the .chm file will be displayed with its default page.

There are many sources of information on creating and compiling HTML help or .chm files. A good starting point is the "Microsoft HTML Help 1.4 SDK" topic available from the Microsoft library ( In the library, you'll also find information on creating and compiling .chm files listed under Visual Tools and Languages, HTML Help.

  1. Right-click the tool and click Properties.
  2. Click the Help tab.
  3. Check Reference a compiled help (CHM) file for the tool help.
  4. Browse to the location of the .chm file, select it, then click Open.
  5. In the Properties window, enter a help context ID that corresponds to the topic in the .chm file.
  6. Click OK.