[VB.NET] Help Files

[Paul M]

I recently completed a project which required me to provide some sort of user documentation so i decided to include a help file in my project.

Once you have compiled your help file, add it to your project by clicking:
Project --> Add Existing Item

Once the dialog box appears browse for your compiled help file and select and add it to the project. Now we need to add the Help Provider control to the form. Simply drag an drop the Help Provider control (F1 button as icon) on to your form. Now the control should appear at the bottom of the screen.

Now we need to set the HelpNameSpace property of the control to ..\HelpFile.chm the file name would be the name of the file you added to your project.

Once you have completed that all that is left is to make the Help File appear

'show the contents of the help file
Help.ShowHelp (Me, HelpProvider1.HelpNameSpace)

'show the index page of the help file
Help.ShowHelpIndex (Me, HelpProvider1.HelpNameSpace)

'show the search tab of the help file
Help.ShowHelp (Me, HelpProvider1.HelpNameSpace, HelpNavigator.Find, "")