Overview:
The HelpViewerEmbeddedClient is used to make DotNet Help context-sensitive help (CSH) calls. HelpViewerEmbeddedClient supports embedded CSH calls and can also provide dynamic help functionality. HelpViewerEmbeddedClient will open the Help Viewer in the same process as your application.
To use the HelpViewerEmbeddedClient, you will first need to create an instance of the class using the constructor. You will then need to call Load() or TryLoad() to load the help system of your choice. You are then free to use the functionality of the HelpSystem object.
Name | Description |
---|---|
public void HelpViewerEmbeddedClient() | Creates an instance of the HelpViewerEmbeddedClient. |
public void HelpViewerEmbeddedClient( string title ) | Creates an instance of the HelpViewerEmbeddedClient. Sets the title of the help system to the string specified in title. |
public void HelpViewerEmbeddedClient( string title, Icon icon ) | Creates an instance of the HelpViewerEmbeddedClient. Sets the title of the help system to the string specified in title. Sets the icon of the help system to the icon specified in icon. |
public void Load( string helpsystem ) | Loads the help system at the path specified in the helpsystem parameter. This method must be called once before calling Search() or ShowTopic(). If the help system does not exist, an ArgumentException is thrown. See also TryLoad(). |
public bool TryLoad( string helpsystem ) | See Load(). This method is equivalent to the Load() method, however, instead of throwing an exception, it returns true if the help system was loaded successfully and returns false otherwise. |
public IEmbeddedHelpSystem HelpSystem | Gets an interface to the help system. See IEmbeddedHelpSystem for more information. |
public virtual string Title | Gets the title of the help system. |
Refer to the sample application called HelpViewerEmbeddedClientTester for a fully functional application which uses the HelpViewerEmbeddedClient API.