Help.ShowHelpIndex(Control, String) Methode

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs

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);
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 Element, das das übergeordnete Element des Dialogfelds "Hilfe" angibt.

url
String

Der Pfad und der Name der Hilfedatei.

Beispiele

Im folgenden Codebeispiel wird ein Formular mit drei Schaltflächen angezeigt, die für die Interaktion mit der Mspaint.chm-Hilfedatei verwendet werden können. 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 z. B. die Ovals-Hilfeseite nach dem Indexwert anzeigen möchten, wählen Sie den HelpNavigator.KeywordIndex Wert in der Dropdownliste "Hilfenavigator" aus, geben Sie im Textfeld "Parameter" Ovale ein, und klicken Sie dann auf die Schaltfläche "Hilfe anzeigen". Geben Sie "Mspaint.chm::/paint_brush.htm in das Textfeld "Stichwort anzeigen" ein, um das Hilfethema "Mit einem Pinsel zu zeichnen" ein, und klicken Sie dann auf die Schaltfläche " Schlüsselwort anzeigen ".

Dieses Beispiel zeigt nur den Aufruf der ShowHelpIndex Methode. Help Die Klassenübersicht finden Sie im vollständigen 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 der Form C:\path\sample.chm oder /folder/file.htmsein.

Gilt für:

Weitere Informationen