Help.ShowHelpIndex(Control, String) Methode

Definition

Zeigt den Index der angegebenen Hilfedatei an.Displays the index of the specified Help file.

public:
 static void ShowHelpIndex(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelpIndex (System.Windows.Forms.Control parent, string url);
static member ShowHelpIndex : System.Windows.Forms.Control * string -> unit
Public Shared Sub ShowHelpIndex (parent As Control, url As String)

Parameter

parent
Control

Ein Control, das das übergeordnete Element des Hilfedialogfelds bezeichnet.A Control that identifies the parent of the Help dialog box.

url
String

Pfad und Name der Hilfedatei.The path and name of the Help file.

Beispiele

Im folgenden Codebeispiel wird ein Formular mit drei Schaltflächen angezeigt, die für die Interaktion mit der Hilfedatei "mspaint. chm" verwendet werden können.The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. Die Schaltfläche " Hilfe Index anzeigen " zeigt die Registerkarte Index für die Hilfedatei an.The Show Help Index button displays the Index tab for the Help file. Auf der Schaltfläche Hilfe anzeigen wird der Inhalt in der Hilfedatei auf Grundlage des in der Liste Hilfe Navigator ausgewählten Werts angezeigt.The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. Die Schaltfläche Schlüsselwort anzeigen zeigt den Inhalt in der Hilfedatei auf Grundlage des Schlüssel Worts an, das im Textfeld Schlüsselwort angegeben ist.The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

Wenn Sie z. b. die Hilfeseite für ovale anhand des Indexwerts anzeigen möchten, wählen Sie in der Dropdown Liste Help Navigator den Wert HelpNavigator.KeywordIndex aus, geben Sie im Textfeld Parameter den Wert ovale ein, und klicken Sie dann auf die Schaltfläche Hilfe anzeigen .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. Geben Sie im Textfeld " Schlüsselwort " den Wert " Mspaint. chm::/paint_brush. htm " ein, und klicken Sie dann auf die Schaltfläche " Schlüsselwort anzeigen ", um das Hilfethema "zum Zeichnen mit einem Pinsel" anzuzeigen.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.

In diesem Beispiel wird nur der aufzurufende ShowHelpIndex-Methode gezeigt.This example shows only the call to the ShowHelpIndex method. Das gesamte Codebeispiel finden Sie in der Übersicht über Help-Klasse.See the Help class overview for the complete code example.

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }
private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}
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

Hinweise

Der url-Parameter kann die Form "c:\path\sample.chm" oder "/Folder/file.htm" aufweisen.The url parameter can be of the form C:\path\sample.chm or /folder/file.htm.

Sicherheit

WebPermission
für den Zugriff auf eine HTML-Hilfedatei über eine HTTP-Anforderung.for accessing an HTML Help file through an HTTP request. Zugehörige Enumeration: ConnectAssociated enumeration: Connect

SecurityPermission
für den Zugriff auf eine HTML-Hilfedatei, die von einem HTTP-Server nicht verarbeitet wirdfor accessing an HTML Help file not served from an HTTP server. Zugehörige Enumeration: UnmanagedCodeAssociated enumeration: UnmanagedCode

Gilt für:

Siehe auch