Freigeben über

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

  • Artikel

Die Komponente "Windows Forms HelpProvider" wird verwendet, um eine HTML-Hilfedatei 1.x-Hilfedatei (entweder eine .chm-Datei, die mit dem HTML-Hilfe-Workshop erstellt wurde, oder eine .htm-Datei) Ihrer Windows-Anwendung zuzuordnen. Sie können auf unterschiedliche Weise Hilfe 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, den Index oder eine Suchfunktion.

Verwenden des Hilfeanbieters

Durch das Hinzufügen einer HelpProvider-Komponente zu Ihrem Windows-Formular erhalten die anderen Steuerelemente auf dem Formular die Möglichkeit, die Hilfeeigenschaften der HelpProvider-Komponente offenzulegen. Auf diese Weise können Sie Hilfe für die Steuerelemente auf Ihrem Windows-Formular bereitstellen. Sie können der HelpProvider Komponente mithilfe der HelpNamespace-Eigenschaft eine Hilfedatei zuordnen. Sie spezifizieren den Typ der Hilfe, die durch den Aufruf von SetHelpNavigator bereitgestellt wird, und wählen einen Wert aus der HelpNavigator-Enumeration für das angegebene Steuerelement aus. Sie stellen das Schlüsselwort oder Thema bereit für die Hilfe, indem Sie die SetHelpKeyword-Methode aufrufen.

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

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

Anmerkung

Beim Angeben des Pfads zur Hilfedatei in der ShowHelp-Methode oder der HelpNamespace-Eigenschaft des Steuerelements HelpProvider können Probleme auftreten. Daher sollten Sie unbedingt den absoluten Dateipfad verwenden, um die Hilfedatei anzugeben.

Siehe auch