How to use the Help Provider

Ask questions about creating Graphical User Interfaces (GUI) in PowerShell and using WinForms controls.
Forum rules
Do not post any licensing information in this forum.

Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
Post Reply
User avatar
timstspry17
Posts: 40
Joined: Sun Sep 06, 2015 9:31 pm

How to use the Help Provider

Post by timstspry17 » Tue Sep 17, 2019 5:11 am

Hello, I am looking for information on how to use the F1 help provider? I need to know:

1. How is the help file to be displayed authored? Do I need a certain tool for this?

2. How do I tie a topic in the help file to a particular control on a form?

Thanks in advance!

Tim

User avatar
jvierra
Posts: 13793
Joined: Tue May 22, 2007 9:57 am
Contact:

Re: How to use the Help Provider

Post by jvierra » Tue Sep 17, 2019 10:41 am

Here is the documentation for the "Help" provider. It will explain how to use help in a Form. You will have to use the Windows Help SDK to create a help file for your form.

https://docs.microsoft.com/en-us/dotnet ... mework-4.8

User avatar
jvierra
Posts: 13793
Joined: Tue May 22, 2007 9:57 am
Contact:

Re: How to use the Help Provider

Post by jvierra » Tue Sep 17, 2019 3:23 pm

Note that, by default, the help provider can be tied t any control by setting the control's "HelpString" property to show the text you wish to display.

User avatar
timstspry17
Posts: 40
Joined: Sun Sep 06, 2015 9:31 pm

Re: How to use the Help Provider

Post by timstspry17 » Wed Sep 18, 2019 4:09 am

Thank you very much for this information. It is very helpful!

Tim

Post Reply