Freigeben über

Übersicht über die HelpProvider-Komponente (Windows Forms)

  • Artikel

Aktualisiert: November 2007

Die HelpProvider-Komponente von Windows Forms wird verwendet, um eine HTML Help 1.x-Hilfedatei (entweder eine mit HTML Help Workshop erstellte CHM-Datei oder eine HTM-Datei) mit einer Windows-Anwendung zu verknüpfen. Sie können auf mehrere Arten Hilfe zur Verfügung stellen:

  • Bereitstellen von kontextabhängiger Hilfe für Steuerelemente auf Windows Forms

  • Bereitstellen von kontextabhängiger Hilfe zu einem bestimmten Dialogfeld oder zu bestimmten Steuerelementen in einem Dialogfeld

  • Öffnen einer Hilfedatei zu bestimmten Bereichen, z. B. die Hauptseite des Inhaltsverzeichnisses, Index oder eine Suchfunktion

Verwenden der HelpProvider-Komponente

Durch Hinzufügen einer HelpProvider-Komponente zu einem Windows Form können die anderen Steuerelemente auf dem Formular die Help-Eigenschaften der HelpProvider-Komponente verfügbar machen. Dadurch können Sie Hilfe für die Steuerelemente auf dem Windows Form bereitstellen. Sie können der HelpProvider-Komponente mit der HelpNamespace-Eigenschaft eine Hilfedatei zuordnen. Sie können den Typ der bereitgestellten Hilfe angeben, indem Sie SetHelpNavigator aufrufen und einen Wert aus der HelpNavigator-Enumeration für das angegebene Steuerelement bereitstellen. Das Schlüsselwort oder Thema für die Hilfe wird durch Aufrufen der SetHelpKeyword-Methode bereitgestellt.

Sie können eine bestimmte Hilfezeichenfolge mit der SetHelpString-Methode auch einem anderen Steuerelement zuordnen. Die Zeichenfolge, die Sie über diese Methode mit einem Steuerelement verknüpfen, wird in einem Popupfenster angezeigt, wenn der Benutzer die Taste F1 drückt, während der Fokus auf dem Steuerelement liegt.

Wenn HelpNamespace nicht festgelegt wurde, müssen Sie den Hilfetext mit SetHelpString bereitstellen. Wenn Sie sowohl HelpNamespace als auch die Hilfezeichenfolge festgelegt haben, hat die Hilfe auf der Basis von HelpNamespace Vorrang.

Hinweis:

Wenn Sie den Pfad zur Hilfedatei in der ShowHelp-Methode oder der HelpNamespace-Eigenschaft des HelpProvider-Steuerelements angeben, können bei Verwendung des relativen Pfads Probleme auftreten. Daher sollten Sie zur Angabe der Hilfedatei unbedingt den absoluten Dateipfad verwenden.

Siehe auch

Konzepte

Hilfesysteme in Windows Forms-Anwendungen