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

  • Artikel

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 Hilfe auf verschiedene Arten bereitstellen:

  • Stellen Sie kontextbezogene Hilfe für Steuerelemente in Windows Forms bereit.

  • Stellen Sie kontextbezogene Hilfe für ein bestimmtes Dialogfeld oder bestimmte Steuerelemente in einem Dialogfeld bereit.

  • Öffnen Sie eine Hilfedatei für bestimmte Bereiche, z. B. die Hauptseite eines Inhaltsverzeichnisses, eines Index oder einer Suchfunktion.

Verwenden des Hilfeanbieters

Wenn Sie Ihrem Windows-Formular eine HelpProvider-Komponente hinzufügen, können die anderen Steuerelemente des Formulars die Hilfeeigenschaften der HelpProvider-Komponente verfügbar machen. Auf diese Weise können Sie Hilfe für die Steuerelemente Ihres Windows-Formulars bereitstellen. Mit der HelpNamespace-Eigenschaft können Sie der HelpProvider-Komponente eine Hilfedatei zuordnen. Sie geben die Art der bereitgestellten Hilfe an, indem Sie SetHelpNavigator aufrufen und einen Wert aus der HelpNavigator-Enumeration für das angegebene Steuerelement bereitstellen. Sie geben das Stichwort oder Thema für die Hilfe an, indem Sie die SetHelpKeyword-Methode aufrufen.

Wenn Sie eine bestimmte Hilfezeichenfolge einem anderen Steuerelement zuordnen möchten, verwenden Sie optional die SetHelpString-Methode. Die Zeichenfolge, die Sie mit dieser Methode einem Steuerelement zuordnen, wird in einem Popupfenster angezeigt, wenn der Benutzer die F1-TASTE drückt, während das Steuerelement den Fokus hat.

Wenn HelpNamespace nicht festgelegt wurde, müssen Sie SetHelpString verwenden, um den Hilfetext anzugeben. Wenn Sie sowohl HelpNamespace als auch die Hilfezeichenfolge festgelegt haben, hat die auf HelpNamespace basierende Hilfe Vorrang.

Hinweis

Wenn Sie den Pfad zur Hilfedatei in der ShowHelp-Methode oder HelpNamespace-Eigenschaft des HelpProvider-Steuerelements angeben, können Probleme bei der Verwendung des relativen Pfads auftreten. Wählen Sie daher unbedingt den absoluten Dateipfad, um die Hilfedatei anzugeben.

Weitere Informationen