HelpProvider – a c# misnomer I felt??


Okay, so the title is a bit misleading, It Starts by stating HelpProvider, That’s what MS call’s it’s F1 key and mouse over help click thing. But the documentation is a little sparse and what does exist is very repetitive. What I wanted was a nice example of how to get this to work with web hosted html via a url.

Lot’s of searching with http etc. in the search criteria does not help in google and the like.

Anyway, it turns out to be be trivial once you know what to do (And ignore the chm / htm [see no L on the end!] examples)

Process:

  1. Create the HelpProvider instance on your form
  2. Put in the root url for the help page (Singular) into the HelpProvider
  3. Make sure the form has the HelpButton field set to true to show the question mark in the Title bar.HelpTitleBar

 

  1. For each of the Form elements that you wish to provide web help to you need to click on the HelpKeyword field and type inthe anchor offset (The bit that will go after the url and not including the #)
  2. Then in the HelpNavigator select Topic :HelpNavigator

Run the application, Click on the the little help icon or press F1 and then click on the control that you set the data above on. Using the example above will turn the data into the following link location and start the default browser to go to it:

http://elucidate.codeplex.com/wikipage?title=Settings#SnapRAID.Exe

Easy.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s