C1.Win.C1DynamicHelp.Providers.IHelpProvider
IHelpProvider Interface
The interface that needs to be implemented by a help provider class.
Namespace: C1.Win.C1DynamicHelp.Providers
Assembly: C1.Win.C1DynamicHelp.4.8.dll
Syntax
public interface IHelpProviderRemarks
You need to know this interface only if you want to create your own custom help provider (an advanced feature). A help provider can read data from a help source and provides methods to get help topics, to get context IDs, to open help in an external window, to get a topic URL that can be displayed by the C1DynamicHelp control, etc. There are two built-in help providers in the C1DynamicHelp: ChmProvider and NetHelpProvider which are used automatically when the HelpSource property points to a .chm or a .htm/html file, correspondingly. If you want to use another help source type (for example, MS Help 2.0) you can do it by creating your own help provider class implementing this interface.
Properties
| Name | Description |
|---|---|
| Source | Gets or sets the help file. |
Methods
| Name | Description |
|---|---|
| CorrectUrl(string) | Checks whether the URL is in correct format and corrects it if necessary. |
| GetCtxtIdMap() | Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). |
| GetFullUrl(string) | Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. |
| GetTopics() | Returns a hierarchical list of topics in the help file. |
| GetUrlMap() | Returns a dictionary of help topics indexed by their URLs (contains all topics). |
| ShowExternalHelp(HelpTab) | Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. |
| ShowExternalHelp(HelpTab, object) | Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. |