System.Windows.Forms.Help.ShowHelp Method

Displays the contents of the Help file located at the URL supplied by the user.

Syntax

public static void ShowHelp (Control parent, string url, HelpNavigator command, object parameter)

Parameters

parent
A System.Windows.Forms.Control that identifies the parent of the Help dialog box.
url
The path and name of the Help file.
command
One of the System.Windows.Forms.HelpNavigator values.
parameter
A string that contains the topic identifier.

Remarks

Compiled Help files provide table-of-contents, index, search, and keyword links in pages. You can use the param parameter to provide additional refinement of the HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex command. If the value specified in the command parameter is HelpNavigator.TableOfContents, HelpNavigator.Index, or HelpNavigator.Find, this value should be an empty string. If the command parameter references HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex, this value should be a string that contains the topic name, or the keyword or numeric identifier of the topic to display.

The url parameter can be of the form C:\path\sample.chm or /folder/file.htm.

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0