HtmlHelp Class Members
The following tables list the members exposed by HtmlHelp.
Public Properties
| Name | Description | |
|---|---|---|
 | ContextHelpIndex | Gets or sets the index file for context lookup. |
| DefaultContextAlias | The default .chm alias to use for context lookups. |
| HelpAboutForm | Gets the form to display for help about. |
| HelpFile | Gets or sets the application .chm html help file. |
| HelpOnHelpFile | Gets or sets the help file to use for help on help. |
 | Instance | Returns implementation of this class. |
| OnTop | Gets or sets whether the help window is owned by the application window an will always be on top. |
| UrlBase | Base URL. |
| Visible | Gets a value indicating whether this Aveva.ApplicationFramework.Presentation.HtmlHelp is visible. |
Public Methods
| Name | Description | |
|---|---|---|
 | Close | Closes this Aveva.ApplicationFramework.Presentation.HtmlHelp. |
| ShowHelpAbout | Shows the help about form as a modal dialog. |
| ShowHelpALink | Displays the help window at the topic with the given associative link. |
| ShowHelpContents | Displays the help window with the contents pane active. |
| ShowHelpContext | Overloaded. Displays the help window at the topic associated with the given contextId. The help topic is determined via a lookup in the context help index. |
| ShowHelpIndex | Displays the help window with the index pane active. |
| ShowHelpKeyword | Displays the help window at the topic with the given keyword. |
| ShowHelpOnHelp | Show a help window for help on help if a help on help file has been specified. |
| ShowHelpSearch | Displays the help window with the search pane active. |
| ShowOnlineLink | Opens a browser window for the given URL. |
See Also