Discussion:
Object browser help topics
(too old to reply)
Andrew Jarvis
2009-05-01 09:06:09 UTC
Permalink
How do I specify the help topic that the Object Browser will display when
the F1 key is pressed?

To put it another way - Is there a Dot Net equivalent of the COM
'helpcontext' attribute?
Rob Chandler [MVP]
2009-05-02 01:15:05 UTC
Permalink
Hi Andrew
Bit out of practice C# and VB .NET. I think you simply add
the HelpProvider component to the form and then each
control will get a field (in the Property window) to add a context ID.

This artical by Michael Waltuch may help
http://helpware.net/mshelp2/demo2/h1xNET.htm

Rob
MS Help MVP
www.helpware.net
Post by Andrew Jarvis
How do I specify the help topic that the Object Browser will display when
the F1 key is pressed?
To put it another way - Is there a Dot Net equivalent of the COM
'helpcontext' attribute?
Andrew Jarvis
2009-05-18 08:10:49 UTC
Permalink
Post by Rob Chandler [MVP]
Hi Andrew
Bit out of practice C# and VB .NET. I think you simply add
the HelpProvider component to the form and then each
control will get a field (in the Property window) to add a context ID.
This artical by Michael Waltuch may help
http://helpware.net/mshelp2/demo2/h1xNET.htm
Rob
MS Help MVP
www.helpware.net
Post by Andrew Jarvis
How do I specify the help topic that the Object Browser will display when
the F1 key is pressed?
To put it another way - Is there a Dot Net equivalent of the COM
'helpcontext' attribute?
My apologies, I did not make the question clear enough.

I am developing a class library and want to provide help for a programmer
using the various methods and properties. Under COM this was done using
'helpcontext' attributes in the IDL file. I cannot find equivalent
attributes for Dot Net.
Rob Chandler [MVP]
2009-05-19 09:18:35 UTC
Permalink
Hi Andrew

Under .NET languages you would use
tripple slash comments /// and then use Sandcastle to
capture all these comments into a CHM or HxS help file.

For VS 2002/2003/2005/2008 the help system is MS Help 2
(.HxS). The easiest way to produce a .HxS from
your class code is using Sandcastle and /// comments.
I assume this is how MS do most of their help.

So a better place to ask your question may be in
http://social.msdn.microsoft.com/Forums/en-US/devdocs/threads

Not sure how you connect F1 up. MS Help 2 allows you to
specify a F1 index that links contextIDs to topics in you HxS.

All too complicated. Sorry I can't be of more help.
In Michael's example he makes a HxS file (by hand) and
links some controls via F1
http://helpware.net/mshelp2/demo/DynamicHelp.htm

That's about all the info or misinformation I can give you.
Hopefully that will give you some leads to Google up some
more info. Now you just need a good MS tutorial...

--

Of course as the class or component writer you can add description comments
to you class and members.
[Description("Based on the standards forms Panel control with extra settings
(see Misc properties) for controlling global spacing etc.")]
public partial class GroupPanel : Panel

[Description("Each page can belong to Group ID. Static gobal methods can
target a group.")]
public int PageGroup
{
get { return pageGroup; }
set { pageGroup = value; }
}

--

And of course there is code complete tips that you should get for free

Rob
Post by Andrew Jarvis
Post by Rob Chandler [MVP]
Hi Andrew
Bit out of practice C# and VB .NET. I think you simply add
the HelpProvider component to the form and then each
control will get a field (in the Property window) to add a context ID.
This artical by Michael Waltuch may help
http://helpware.net/mshelp2/demo2/h1xNET.htm
Rob
MS Help MVP
www.helpware.net
Post by Andrew Jarvis
How do I specify the help topic that the Object Browser will display
when the F1 key is pressed?
To put it another way - Is there a Dot Net equivalent of the COM
'helpcontext' attribute?
My apologies, I did not make the question clear enough.
I am developing a class library and want to provide help for a programmer
using the various methods and properties. Under COM this was done using
'helpcontext' attributes in the IDL file. I cannot find equivalent
attributes for Dot Net.
Loading...