Using F1 Help (CHM format) With WPF

phyllis diller picture phyllis diller · May 29, 2009 · Viewed 33.6k times · Source

I've been working on a WPF application for a while, and the time has come to attach the CHM format help document to it.

But alas! HelpProvider, the standard way to show CHM files in Winforms, has magically vanished and has no counterpart in WPF. I've been trying to use WindowsFormsHost to spawn a new control so I can actually display the help, but essentially it just grabs control of the entire UI.

A little more detail: I've got a menu item that I want to, when clicked, open up the CHM file.

First I set up the WindowsFormsHost...

host = new System.Windows.Forms.Integration.WindowsFormsHost();
helpForm = new System.Windows.Forms.Control();
host.Child = helpForm;
host.Visibility = System.Windows.Visibility.Hidden;
this.grid1.Children.Add(host);

hp = new System.Windows.Forms.HelpProvider();
hp.HelpNamespace = "Somehelpfile.chm";
hp.SetHelpNavigator(helpForm, System.Windows.Forms.HelpNavigator.TableOfContents);

And then I say, voila, reveal yourself.

private void Help_Click(object sender, RoutedEventArgs e)
{
    host.Visibility = Visibility.Visible;
    helpForm.Show();
    hp.SetShowHelp(helpForm, true);
}  

I'm not really sure of where to proceed from here. When I show the helpForm, it obscures / overrides the existing UI and all I get is a gray, empty WPF window with no help file.

Any takers?

Answer

Cameron MacFarland picture Cameron MacFarland · Aug 31, 2009

If you include System.Windows.Forms.dll you can also do:

System.Windows.Forms.Help.ShowHelp(null, @"help.chm");

Also, there's an article here about adding a context sensitive help system to WPF.