Help.ShowHelpIndex-Methode

Zeigt den Index der angegebenen Hilfedatei an.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

'Declaration
Public Shared Sub ShowHelpIndex ( _
    parent As Control, _
    url As String _
)
'Usage
Dim parent As Control
Dim url As String

Help.ShowHelpIndex(parent, url)

public static void ShowHelpIndex (
    Control parent,
    string url
)

public:
static void ShowHelpIndex (
    Control^ parent, 
    String^ url
)

public static void ShowHelpIndex (
    Control parent, 
    String url
)

public static function ShowHelpIndex (
    parent : Control, 
    url : String
)

Parameter

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

• url
  Pfad und Name der Hilfedatei.

Hinweise

Der url-Parameter kann die Form C:\Pfad\Beispiel.chm oder /Ordner/Datei.htm haben.

Beispiel

Im folgenden Codebeispiel wird ein Formular mit drei Schaltflächen veranschaulicht, das für die Interaktion mit der Hilfedatei mspaint.chm verwendet werden kann. Die Schaltfläche Hilfeindex anzeigen zeigt die Registerkarte Index für die Hilfedatei an. Die Schaltfläche Hilfe anzeigen zeigt auf der Grundlage des in der Liste Hilfenavigator ausgewählten Werts den Inhalt in der Hilfedatei an. Die Schaltfläche Schlüsselwort anzeigen zeigt auf der Grundlage des im Textfeld Schlüsselwort ausgewählten Schlüsselwortes den Inhalt in der Hilfedatei an.

Um beispielsweise die Hilfeseite zu Ellipsen nach dem Indexwert anzuzeigen, wählen Sie in der Dropdownliste Hilfenavigator den HelpNavigator.KeywordIndex-Wert aus, geben Sie im Textfeld ParameterEllipsen ein, und klicken Sie dann auf die Schaltfläche Hilfe anzeigen. Wenn das Hilfethema "To paint with a brush" anhand des Schlüsselworts angezeigt werden soll, geben Sie im Textfeld Schlüsselwortmspaint.chm::/paint_brush.htm ein, und klicken Sie auf die Schaltfläche Schlüsselwort anzeigen.

In diesem Beispiel wird nur der Aufruf der ShowHelpIndex-Methode gezeigt. Das vollständige Codebeispiel finden Sie in der Übersicht zur Help-Klasse.

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 'showIndex_Click

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

.NET Framework-Sicherheit

• WebPermission  für den Zugriff auf eine HTML-Hilfedatei über eine HTTP-Anforderung. Zugeordnete Enumeration: NetworkAccess.Connect
• SecurityPermission  für den Zugriff auf eine von einem HTTP-Server nicht bereitgestellte HTML-Hilfedatei. Zugeordnete Enumeration: UnmanagedCode

Plattformen

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

Help-Klasse
Help-Member
System.Windows.Forms-Namespace
ShowHelp