Help.ShowHelp Methode

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Zeigt den Inhalt einer Hilfedatei an.

Überlädt

ShowHelp(Control, String)	Zeigt den Inhalt der Hilfedatei an der angegebenen URL an.
ShowHelp(Control, String, String)	Zeigt den Inhalt der Hilfedatei an der angegebenen URL für ein bestimmtes Schlüsselwort an.
ShowHelp(Control, String, HelpNavigator)	Zeigt den Inhalt der Hilfedatei an der angegebenen URL für ein bestimmtes Thema an.
ShowHelp(Control, String, HelpNavigator, Object)	Zeigt den Inhalt der Hilfedatei an der vom Benutzer angegebenen URL an.

ShowHelp(Control, String)

Zeigt den Inhalt der Hilfedatei an der angegebenen URL an.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url);

static member ShowHelp : System.Windows.Forms.Control * string -> unit

Public Shared Sub ShowHelp (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 die ShowHelp -Methode veranschaulicht. Fügen Sie zum Ausführen dieses Beispiels den folgenden Code in ein Formular ein, das eine Schaltfläche mit dem Namen Button1enthält.

// Open the Help file for the Character Map topic.  
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}

// Open the Help file for the Character Map topic.  
private void Button1_Click(System.Object sender, System.EventArgs e)
{

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

' Open the Help file for the Character Map topic.  
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub

Hinweise

Das url Argument kann das Format C:\path\sample.chm oder /folder/file.htmhaben. Informationen zum Format von Pfaden finden Sie unter Pfadformate auf Windows-Systemen.

Weitere Informationen

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Zeigt den Inhalt der Hilfedatei an der angegebenen URL für ein bestimmtes Schlüsselwort an.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, string? keyword);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

Parameter

parent

Control

Ein Control, das das übergeordnete Element des Hilfedialogfelds bezeichnet.

url

String

Pfad und Name der Hilfedatei.

keyword

String

Das Schlüsselwort, für das die Hilfe angezeigt werden soll.

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. 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 Liste Help Navigator ausgewählt ist. Auf der Schaltfläche Schlüsselwort anzeigen werden Inhalte in der Hilfedatei basierend auf dem im Textfeld Schlüsselwort angegebenen Schlüsselwort (keyword) angezeigt.

Wenn Sie beispielsweise die Ovals-Hilfeseite anhand des Indexwerts anzeigen möchten, wählen Sie den Wert in der HelpNavigator.KeywordIndex Dropdownliste Help Navigator aus, geben Sie ovals in das Textfeld Parameter ein, und klicken Sie dann auf die Schaltfläche Hilfe anzeigen . Geben Sie mspaint.chm::/paint_brush.htm in das Textfeld Schlüsselwort ein, um das Hilfethema "Mit einem Pinsel malen" nach dem Schlüsselwort (keyword) anzuzeigen, und klicken Sie dann auf die Schaltfläche Schlüsselwort anzeigen.

Dieses Beispiel zeigt nur den Aufruf der ShowHelp -Methode. Das vollständige Codebeispiel finden Sie in der Help Klassenübersicht.

void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display help using the provided keyword.
   Help::ShowHelp( this, helpfile, keyword->Text );
}

private void showKeyword_Click(object sender, System.EventArgs e)
{
    // Display help using the provided keyword.
    Help.ShowHelp(this, helpfile, keyword.Text);
}

Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
    ' Display Help using the provided keyword. 
    Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub

Hinweise

Das url Argument kann das Format C:\path\sample.chm oder /folder/file.htmhaben. Informationen zum Format von Pfaden finden Sie unter Pfadformate auf Windows-Systemen.

Wenn keyword ist null, wird das Inhaltsverzeichnis für die Hilfedatei angezeigt.

Weitere Informationen

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Zeigt den Inhalt der Hilfedatei an der angegebenen URL für ein bestimmtes Thema an.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)

Parameter

parent

Control

Ein Control, das das übergeordnete Element des Hilfedialogfelds bezeichnet.

url

String

Pfad und Name der Hilfedatei.

navigator

HelpNavigator

Einer der HelpNavigator-Werte.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie Sie die ShowHelp -Methode verwenden, um eine Hilfedatei auf ihrer Indexseite zu öffnen. Fügen Sie zum Ausführen dieses Beispiels den folgenden Code in ein Formular ein, das eine Schaltfläche mit dem Namen Button2enthält.

// Open the Help file for the Character Map topic and 
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}

// 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);
}

' Open the Help file for the Character Map topic and 
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click

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

Hinweise

Das url Argument kann das Format C:\path\sample.chm oder /folder/file.htmhaben. Informationen zum Format von Pfaden finden Sie unter Pfadformate auf Windows-Systemen.

Kompilierte Hilfedateien stellen Inhaltsverzeichnisse, Index-, Such- und Schlüsselwort (keyword) Links auf Seiten bereit. Sie können die folgenden Werte für das navigator Argument verwenden: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexoder HelpNavigator.Topic.

Weitere Informationen

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Zeigt den Inhalt der Hilfedatei an der vom Benutzer angegebenen URL an.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parameter

parent

Control

Ein Control, das das übergeordnete Element des Hilfedialogfelds bezeichnet.

url

String

Pfad und Name der Hilfedatei.

command

HelpNavigator

Einer der HelpNavigator-Werte.

parameter

Object

Eine Zeichenfolge, die den Themenbezeichner enthält.

Ausnahmen

ArgumentException

parameter ist eine ganze Zahl.

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. 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 Liste Help Navigator ausgewählt ist. Auf der Schaltfläche Schlüsselwort anzeigen werden Inhalte in der Hilfedatei basierend auf dem im Textfeld Schlüsselwort angegebenen Schlüsselwort (keyword) angezeigt.

Wenn Sie beispielsweise die Ovals-Hilfeseite anhand des Indexwerts anzeigen möchten, wählen Sie den Wert in der HelpNavigator.KeywordIndex Dropdownliste Help Navigator aus, geben Sie ovals in das Textfeld Parameter ein, und klicken Sie dann auf die Schaltfläche Hilfe anzeigen . Geben Sie mspaint.chm::/paint_brush.htm in das Textfeld Schlüsselwort ein, um das Hilfethema "Mit einem Pinsel malen" nach dem Schlüsselwort (keyword) anzuzeigen, und klicken Sie dann auf die Schaltfläche Schlüsselwort anzeigen.

Dieses Beispiel zeigt nur den Aufruf der ShowHelp -Methode. Das vollständige Codebeispiel finden Sie in der Help Klassenübersicht.

void showHelp_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display Help using the Help navigator enumeration
   // that is selected in the combo box. Some enumeration
   // values make use of an extra parameter, which can
   // be passed in through the Parameter text box.
   HelpNavigator navigator = HelpNavigator::TableOfContents;
   if ( navigatorCombo->SelectedItem != nullptr )
   {
      navigator =  *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
   }

   Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}

private void showHelp_Click(object sender, System.EventArgs e)
{
    // Display Help using the Help navigator enumeration
    // that is selected in the combo box. Some enumeration
    // values make use of an extra parameter, which can
    // be passed in through the Parameter text box.
    HelpNavigator navigator = HelpNavigator.TableOfContents;
    if (navigatorCombo.SelectedItem != null)
    {
        navigator = (HelpNavigator)navigatorCombo.SelectedItem;
    }
    Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
}

Private Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
    ' Display Help using the Help navigator enumeration
    ' that is selected in the combo box. Some enumeration
    ' values make use of an extra parameter, which can
    ' be passed in through the Parameter text box.
    Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
    If (navigatorCombo.SelectedItem IsNot Nothing) Then
        navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
    End If
    Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub

Hinweise

Das url Argument kann das Format C:\path\sample.chm oder /folder/file.htmhaben. Informationen zum Format von Pfaden finden Sie unter Pfadformate auf Windows-Systemen.

Kompilierte Hilfedateien stellen Inhaltsverzeichnisse, Index-, Such- und Schlüsselwort (keyword)-Links auf Seiten bereit. Sie können das parameter Argument verwenden, um zusätzliche Einschränkungen für den HelpNavigator.TopicBefehl , HelpNavigator.TopicId, HelpNavigator.KeywordIndexoder HelpNavigator.AssociateIndex bereitzustellen. Wenn der im command Argument HelpNavigator.TableOfContentsangegebene Wert , HelpNavigator.Indexoder HelpNavigator.Findist, sollte dieser Wert eine leere Zeichenfolge ("", oder String.Empty) sein. Wenn das command Argument auf , HelpNavigator.TopicId, HelpNavigator.KeywordIndexoder HelpNavigator.AssociateIndexverweistHelpNavigator.Topic, sollte dieser Wert eine Zeichenfolge sein, die den Themennamen oder den Schlüsselwort (keyword) oder numerischen Bezeichner des anzuzeigenden Themas enthält.

Weitere Informationen

• ShowHelpIndex(Control, String)