IEmbeddedHelpSystem API

The IEmbeddedHelpSystem API is an interface that exposes functionality for context-sensitive Help (CSH), embedded Help, and Dynamic Help.

Detached CSH

To launch the Help system in a separate Help Viewer window, use the ShowHelp() method.

To make a CSH call and have the results displayed in a separate Help Viewer window, use the ShowTopic() method.

To display search results from a Help system in a separate Help Viewer window, use the Search() method.

These methods will launch an instance of the Help Viewer application. It will be launched in the same process as your application so when the user closes your application, the Help Viewer will also be closed.

Embedded CSH

To embed a topic from your Help system into your application, use the LoadTopic() method.

To embed search results from your Help system into your application, use the EmbeddedSearch() method.

You must set the DynamicHelpPanel property prior to calling LoadTopic(). Similarly, you must set the SearchPanel property prior to calling EmbeddedSearch().

examples

Refer to the sample application called "HelpViewerEmbeddedClientTester." This sample application is available in the SDK, which you can download from http://www.madcapsoftware.com/downloads/flare020-ke5g.asp.

Dynamic Help 

Dynamic Help is a feature where a Help window automatically displays topics from a Help system that are relevant to the context as an individual uses an application. For example, if the user clicks on an area of your UI called "Project Organizer," the topic pertinent to the Project Organizer opens. You can see an example of Dynamic Help in MadCap Flare's online Help (select Help>Dynamic Help). 

To use this functionality, you must set the EnableDynamicHelp property to true. The CSH engine needs a way to determine the appropriate topic to display. Your application can supply this information in either of two ways.

Name Description
public void EmbeddedSearch( string searchString ) Performs a search for the string specified in the searchString parameter. Displays the results embedded in the control that is set as the SearchPanel property.
public void EnableHelpButton( System.Windows.Forms.Form form ) Enables the Help button in the form specified in form. See the ICSHIDProvider API if you are enabling this feature.
public void LoadTopic( string cshid)

Loads the topic specified in cshid. Displays the topic embedded in the control that is set as the DynamicHelpPanel property.

public void Search( string searchString ) Performs a search for the string specified in the searchString parameter. Displays the results in a new Help Viewer window.
public void Search( string searchString, string cshid )

Performs a search for the string specified in the searchString parameter. The cshid parameter is used to override the default starting topic of the Help system. Displays the results in a new Help Viewer window.

public void ShowHelp() Opens the Help system in a new Help Viewer window.
public void ShowTopic( string cshid ) Opens the Help system with the topic specified in cshid.
System.Windows.Forms.Control DynamicHelpPanel Gets or sets the control where the embedded Help topic will be loaded. This must be set before calling LoadTopic().
bool EnableDynamicHelp Gets or sets whether Dynamic Help is enabled for the form. See the ICSHIDProvider API if you are enabling this feature.
bool EnableF1Help Gets or sets whether F1 Help is enabled for the form. See the ICSHIDProvider API if you are enabling this feature.
System.Windows.Forms.Control SearchPanel Gets or sets the control where the embedded Help search results will be loaded. This must be set before calling EmbeddedSearch().