Andy De George
c0ba284473
* Merge winforms framework content to working branch (#14) * Breadcrumb / TOC / Move net5 to net folder (#15) * change path from net5 to net * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Mess with bread/toc * Add .net 5 winforms placeholder article (#16) * added some metadata and adjusted net5 placeholder * corrections * corrections * corrections * Test1 * Swapping landing page vs concept * fix links * Fix links * Fix desc
3.0 KiB
title, ms.date, f1_keywords, helpviewer_keywords, ms.assetid
| title | ms.date | f1_keywords | helpviewer_keywords | ms.assetid | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| HelpProvider Component Overview | 03/30/2017 |
|
|
6b10c2cc-c577-4cb5-9669-e37b33416af9 |
HelpProvider Component Overview (Windows Forms)
The Windows Forms HelpProvider component is used to associate an HTML Help 1.x Help file (either a .chm file, produced with the HTML Help Workshop, or an .htm file) with your Windows application. You can provide help in a variety of ways:
-
Provide context-sensitive Help for controls on Windows Forms.
-
Provide context-sensitive Help on a particular dialog box or specific controls on a dialog box.
-
Open a Help file to specific areas, such as the main page of a Table of Contents, the Index, or a search function.
Using the Help Provider
Adding a xref:System.Windows.Forms.HelpProvider component to your Windows Form allows the other controls on the form to expose the Help properties of the xref:System.Windows.Forms.HelpProvider component. This enables you to provide help for the controls on your Windows Form. You can associate a Help file with the xref:System.Windows.Forms.HelpProvider component using the xref:System.Windows.Forms.HelpProvider.HelpNamespace%2A property. You specify the type of Help provided by calling xref:System.Windows.Forms.HelpProvider.SetHelpNavigator%2A and providing a value from the xref:System.Windows.Forms.HelpNavigator enumeration for the specified control. You provide the keyword or topic for Help by calling the xref:System.Windows.Forms.HelpProvider.SetHelpKeyword%2A method.
Optionally, to associate a specific Help string with another control, use the xref:System.Windows.Forms.HelpProvider.SetHelpString%2A method. The string that you associate with a control using this method is displayed in a pop-up window when the user presses the F1 key while the control has focus.
If xref:System.Windows.Forms.HelpProvider.HelpNamespace%2A has not been set, you must use xref:System.Windows.Forms.HelpProvider.SetHelpString%2A to provide the Help text. If you have set both xref:System.Windows.Forms.HelpProvider.HelpNamespace%2A and the Help string, Help based on xref:System.Windows.Forms.HelpProvider.HelpNamespace%2A will take precedence.
Note
You may encounter problems using the relative path when specifying the path to the Help file in the xref:System.Windows.Forms.Help.ShowHelp%2A method or xref:System.Windows.Forms.HelpProvider.HelpNamespace%2A property of the xref:System.Windows.Forms.HelpProvider control. As such, be sure to use the absolute file path to specify the Help file.