context-sensitive help when programming in C#

This forum is for all Flare issues related to the DotNet Help target, and the Dot Net Viewer

context-sensitive help when programming in C#

Postby nsemple on Tue Jan 26, 2010 10:02 am

What is the mechanism used to hook up context-sensitive Help in C# (sharp) applications?

What do we provide to developers and what do developers need to do to take advantage of the Dynamic Help and Run-Time Merge Help in C# applications?

When programming in C # (sharp), our developers do not use header files. Based on a Madcap article, where they state that you can use traditional mechanisms (header file and alias file) to hook context-sensitive Help, how would this work in a C# application, if they don't use header files?

We can't find enough information on this in the Flare Help.
Propeller Head
Posts: 86
Joined: Wed Feb 08, 2006 9:24 am

Re: context-sensitive help when programming in C#

Postby akhoff on Tue Feb 02, 2010 6:50 pm

My developers tell me that the code to hook the context sensitive help is as follows:

MadCap.HelpViewerClient.HelpViewerClient helpViewer = new MadCap.HelpViewerClient.HelpViewerClient();
//location of the .mchelp file
helpViewer.Load(@"C:\sv\debug\DotNet Help Build\Manual.mchelp");
//the ID of the topic

We haven't gone any further with this topic. We have decided to use HTML Help instead, so this is the extent of my knowledge. I hope this helps.
Jr. Propeller Head
Posts: 6
Joined: Thu Jan 31, 2008 1:46 pm

Re: context-sensitive help when programming in C#

Postby RamonS on Wed Feb 03, 2010 5:34 am

You may want to download the DotNetHelp SDK from the MadCap web site. I looked at it once during a crazy attempt to program in .NET and if I recall correctly, it has code samples in it.
Senior Propellus Maximus
Posts: 4286
Joined: Thu Feb 02, 2006 9:29 am
Location: The Electric City

Re: context-sensitive help when programming in C#

Postby flashback on Fri Feb 05, 2010 8:12 am

To augment nsemple's question, not being programmers ourselves and not having development resources at this time to look at the code examples, we need more information on how to build Help using dynamic Help and run-time merge for a C# application, and what we need to do to make this work. Is it as simple as installing the APIHelp Client or Embedded API Help Client, and then using the code examples to map topics to areas in the product? Is there special code required to implement run-time merge, whereby specific topics connected to a particular product feature are included only when that feature is installed?

Looking forward to hearing from anyone who can share their knowledge in this area.
Jr. Propeller Head
Posts: 5
Joined: Wed Jan 06, 2010 1:15 pm

Return to DotNet Help and the Dot Net Viewer

Who is online

Users browsing this forum: No registered users and 1 guest