Design Time Help Provider

Question

5.00/5 (1 vote)

See more:

Hi,

I'm building a custom class library in vb.net and would like to be able to specify a help file or web page, so if someone highlights the class name for function in the code editor and presses F1, it will open up the MSDN help app or a web browser showing the documentation I write.

I did try and search for this but the only thing I could find related to form components at runtime with the HelpProvider class.

Is this possible and if so how can it be achieved?

Any help is appreciated, and thanks for your time.

Chris

Posted 19-Jul-10 7:21am

cjelec12

Add a Solution

Comments

ely_bob 19-Jul-10 14:57pm

Reason for my vote of 5
This is a good question.

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Christian Graus · Answer 1 · 2010-07-19T11:24:00

Solution 1

you can create comments that pop up in intellisense, you could put a URL in there, but not a hyperlink.

Posted 19-Jul-10 11:24am

Christian Graus

cjelec12 · Answer 2 · 2010-07-20T04:25:00

Hi Christian,

Thanks for your reply, I'm using the xml styled comments which does provide the intellisense hover help, but I'm trying to find out how to create and specify MSDN help files.

I think I have found something since I originally posted this question. The MSDN library does point to a company who produces a tool for generating MSDN content, Innovasys Document X. However my budget is almost zero so I'm now trying to find a manual process of generating .hxs files that are used by MSDN viewer.

Thanks again

Chris