Help.ShowHelp Method (Control, String, HelpNavigator)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Displays the contents of the Help file found at the specified URL for a specific topic.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public static void ShowHelp(
	Control parent,
	string url,
	HelpNavigator navigator
)

Parameters

parent
Type: System.Windows.Forms.Control

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

url
Type: System.String

The path and name of the Help file.

navigator
Type: System.Windows.Forms.HelpNavigator

One of the HelpNavigator values.

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

Compiled Help files provide table of contents, index, search, and keyword links in pages. You can use the following values for the navigator parameter: TableOfContents, Find, Index, or Topic.

The following code example demonstrates how to use the ShowHelp method to open a Help file to its index page. To run this example, paste the following code into a form that contains a button named Button2.

// Open the Help file for the Character Map topic and 
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{

	Help.ShowHelp(TextBox1, "file://c:\\charmap.chm", 
		HelpNavigator.Index);
}

WebPermission

for accessing an HTML Help file through an HTTP request. Associated enumeration: NetworkAccess.Connect

SecurityPermission

for accessing an HTML Help file not served from an HTTP server. Associated enumeration: UnmanagedCode

.NET Framework
Available since 1.1
Return to top
Show: