Export (0) Print
Expand All

Help.ShowHelpIndex Method

Displays the index of the specified Help file.

[Visual Basic]
Public Shared Sub ShowHelpIndex( _
   ByVal parent As Control, _
   ByVal url As String _
)
[C#]
public static void ShowHelpIndex(
 Control parent,
 string url
);
[C++]
public: static void ShowHelpIndex(
 Control* parent,
 String* url
);
[JScript]
public static function ShowHelpIndex(
   parent : Control,
 url : String
);

Parameters

parent
A Control that identifies the parent of the Help dialog box.
url
The path and name of the Help file.

Remarks

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

Example

[Visual Basic, C#, C++] The following 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 selected in the Help Navigator list. The Show Keyword button displays content in the Help file based on the keyword specified in the Keyword text box.

[Visual Basic, C#, C++] 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" (without the quotation marks) in the Parameter text box, and click the Show Help button. To show the "To paint with a brush" Help topic by the keyword, type "mspaint.chm::/paint_brush.htm" (without the quotation marks) in the Keyword text box and click the Show Keyword button.

[Visual Basic, C#, C++] This example only shows the call to ShowHelpIndex. See the Help class overview for the complete code example.

[Visual Basic] 
Private Sub showIndex_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showIndex.Click
    ' Display the index for the Help file.
    Help.ShowHelpIndex(Me, helpfile)
End Sub 'showIndex_Click

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

[C++] 
private:
   void showIndex_Click(Object* /*sender*/, System::EventArgs* /*e*/) {
      // Display the index for the help file.
      Help::ShowHelpIndex(this, helpfile);
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Help Class | Help Members | System.Windows.Forms Namespace | ShowHelp

Show:
© 2014 Microsoft