Help.ShowHelp Methode

Definition

Zeigt den Inhalt einer Hilfedatei an.

Überlädt

Name Beschreibung
ShowHelp(Control, String)

Zeigt den Inhalt der Hilfedatei an der angegebenen URL an.

ShowHelp(Control, String, String)

Zeigt den Inhalt der Hilfedatei an, die unter der angegebenen URL für ein bestimmtes Schlüsselwort gefunden wurde.

ShowHelp(Control, String, HelpNavigator)

Zeigt den Inhalt der Hilfedatei an, die unter der angegebenen URL für ein bestimmtes Thema gefunden wurde.

ShowHelp(Control, String, HelpNavigator, Object)

Zeigt den Inhalt der Hilfedatei an, die sich auf der vom Benutzer bereitgestellten URL befindet.

ShowHelp(Control, String)

Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs

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

url
String

Der Pfad und der Name der Hilfedatei.

Beispiele

Im folgenden Codebeispiel wird die ShowHelp Methode veranschaulicht. Zum Ausführen dieses Beispiels fügen Sie 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.htm" aufweisen. Informationen zum Format von Pfaden finden Sie unter Dateipfadformate auf Windows Systemen.

Weitere Informationen

Gilt für:

ShowHelp(Control, String, String)

Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs

Zeigt den Inhalt der Hilfedatei an, die unter der angegebenen URL für ein bestimmtes Schlüsselwort gefunden wurde.

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

url
String

Der Pfad und der Name der Hilfedatei.

keyword
String

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

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 ShowHelp Methode. Help Die Klassenübersicht finden Sie im vollständigen Codebeispiel.

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.htm" aufweisen. Informationen zum Format von Pfaden finden Sie unter Dateipfadformate auf Windows Systemen.

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

Weitere Informationen

Gilt für:

ShowHelp(Control, String, HelpNavigator)

Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs

Zeigt den Inhalt der Hilfedatei an, die unter der angegebenen URL für ein bestimmtes Thema gefunden wurde.

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

url
String

Der Pfad und der Name der Hilfedatei.

navigator
HelpNavigator

Einer der HelpNavigator Werte.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der ShowHelp Methode zum Öffnen einer Hilfedatei auf der Indexseite veranschaulicht. Zum Ausführen dieses Beispiels fügen Sie 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.htm" aufweisen. Informationen zum Format von Pfaden finden Sie unter Dateipfadformate auf Windows Systemen.

Kompilierte Hilfedateien stellen Inhaltsverzeichnis, Index, Suche und Stichwortlinks 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

Gilt für:

ShowHelp(Control, String, HelpNavigator, Object)

Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs
Quelle:
Help.cs

Zeigt den Inhalt der Hilfedatei an, die sich auf der vom Benutzer bereitgestellten URL befindet.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ param);
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 param);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, 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
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, param As Object)
Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parameter

parent
Control

Ein Control Element, das das übergeordnete Element des Dialogfelds "Hilfe" angibt.

url
String

Der Pfad und der Name der Hilfedatei.

command
HelpNavigator

Einer der HelpNavigator Werte.

paramparameter
Object

Eine Zeichenfolge, die den Themenbezeichner enthält.

Ausnahmen

parameter ist eine ganze Zahl.

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 ShowHelp Methode. Help Die Klassenübersicht finden Sie im vollständigen Codebeispiel.

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.htm" aufweisen. Informationen zum Format von Pfaden finden Sie unter Dateipfadformate auf Windows Systemen.

Kompilierte Hilfedateien stellen Inhaltsverzeichnis-, Index-, Such- und Schlüsselwortlinks auf Seiten bereit. Sie können das parameter Argument verwenden, um zusätzliche Verfeinerung der HelpNavigator.TopicBefehle , HelpNavigator.TopicId, , HelpNavigator.KeywordIndexoder HelpNavigator.AssociateIndex Befehl bereitzustellen. Wenn der im command Argument HelpNavigator.TableOfContentsangegebene Wert , HelpNavigator.Indexoder HelpNavigator.Find, dieser Wert eine leere Zeichenfolge ("" oder String.Empty). Wenn das command Argument auf eine Zeichenfolge verweistHelpNavigator.Topic, HelpNavigator.TopicIdHelpNavigator.KeywordIndexdie den Themennamen enthält, oder HelpNavigator.AssociateIndexdas Schlüsselwort oder der numerische Bezeichner des anzuzeigenden Themas, sollte dieser Wert eine Zeichenfolge sein.

Weitere Informationen

Gilt für: