Help.ShowHelpIndex(Control, String) Method

Definition

Displays the index of the specified Help file.

C#
public static void ShowHelpIndex(System.Windows.Forms.Control parent, string url);
C#
public static void ShowHelpIndex(System.Windows.Forms.Control? parent, string? url);

Parameters

parent
Control

A Control that identifies the parent of the Help dialog box.

url
String

The path and name of the Help file.

Examples

The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. The Show Help Index button displays the Index tab for the Help file. The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type ovals in the Parameter text box, and then click the Show Help button. To show the "To paint with a brush" Help topic by the keyword, type mspaint.chm::/paint_brush.htm in the Keyword text box, and then click the Show Keyword button.

This example shows only the call to the ShowHelpIndex method. See the Help class overview for the complete code example.

C#
private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}

Remarks

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

Applies to

Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also