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.
This topic is 4 years and 6 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.
Locked
User avatar
timstspry17
Posts: 45
Last visit: Tue Apr 18, 2023 2:49 pm

How to use the Help Provider

Post by timstspry17 »

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
jvierra
Posts: 15439
Last visit: Tue Nov 21, 2023 6:37 pm
Answers: 30
Has voted: 4 times
Been upvoted: 33 times

Re: How to use the Help Provider

Post by jvierra »

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
jvierra
Posts: 15439
Last visit: Tue Nov 21, 2023 6:37 pm
Answers: 30
Has voted: 4 times
Been upvoted: 33 times

Re: How to use the Help Provider

Post by jvierra »

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: 45
Last visit: Tue Apr 18, 2023 2:49 pm

Re: How to use the Help Provider

Post by timstspry17 »

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

Tim
This topic is 4 years and 6 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.
Locked