Skip to main content

Using the HelpProvider to show an HTML help page

In .NET WinForms a HelpProvider component is available to let you add help functionality to your application. While I tried to use this component in one of my applications, I noticed it is poorly documented. I hope this post can help you get started.

The HelpProvider

HelpProvider is an Expander Provider class that contains a number of hashtables to externally add help related properties to windows forms controls. The HelpNamespace string property identifies a help system and must be set to use HelpKeyword/HelpNavigator. It is NOT a namespace. It can be a uri or local file name or possibly other things as well.

The four directly manipulated hashtable properties are:

  • ShowHelp – a Boolean flag that enables the display of help through the HelpProvider.
  • HelpString – a string to display in a pop-up window. Typically activated by clicking on the control when the cursor is a “?” or when the control has focus and HelpNamespace is null.
  • HelpKeyword – a string to identify the help request passed to a help system. Optional. Used to steer a help system to the correct point.
  • HelpNavigator – an enumeration value that guides the help system in what to do with the HelpKeyword.

The HelpProvider registers event handlers on the control’s HelpRequested and QueryAccessibilityHelp events if enabled and minimally configured.

The Help class provides the actual methods for displaying help.

   1:  Help.ShowPopup(parent, caption, location)
   2:   
   3:  Help.ShowHelp(parent, helpNamespace[, helpNavigator[, helpKeyword]])


If HelpNamespace uses “http:” or “https:” schemes then only HelpNavigator.Topic can be used which appends “#”+HelpKeyword onto HelpNamespace.

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more