Help.ShowHelpIndex(Control, String) Methode

Referenz

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Zeigt den Index der angegebenen Hilfedatei an.

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.

url: String

Pfad und Name der Hilfedatei.

Beispiele

Im folgenden Codebeispiel wird ein Formular mit drei Schaltflächen angezeigt, mit denen die mspaint.chm-Hilfedatei interagiert werden kann. Auf der Schaltfläche " Hilfeindex anzeigen " wird die Registerkarte "Index " für die Hilfedatei angezeigt. Auf der Schaltfläche " Hilfe anzeigen" werden Inhalte in der Hilfedatei basierend auf dem Wert angezeigt, der in der Hilfenavigatorliste ausgewählt ist. Auf der Schaltfläche " Schlüsselwort anzeigen" werden Inhalte in der Hilfedatei basierend auf dem Schlüsselwort angezeigt, das im Textfeld "Schlüsselwort " angegeben ist.

Wenn Sie beispielsweise die Ovals-Hilfeseite anhand des Indexwerts anzeigen möchten, wählen Sie den HelpNavigator.KeywordIndex Wert in der Dropdownliste " Hilfenavigator " aus, geben Sie Ovale in das Textfeld "Parameter " ein, und klicken Sie dann auf die Schaltfläche " Hilfe anzeigen ". Um das Hilfethema "Zum Zeichnen mit einem Pinsel" durch das Schlüsselwort anzuzeigen, geben Sie mspaint.chm::/paint_brush.htm im Textfeld "Schlüsselwort anzeigen" ein, und klicken Sie dann auf die Schaltfläche "Schlüsselwort anzeigen ".

In diesem Beispiel wird nur der Aufruf der ShowHelpIndex Methode gezeigt. Weitere Informationen finden Sie in der Help Klassenübersicht für das vollständige Codebeispiel.

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 vom Formular C:\path\sample.chm oder /folder/file.htm sein.

Gilt für

Siehe auch

ShowHelp(Control, String)