Freigeben über

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

Die Windows Forms HelpProvider-Komponente wird verwendet, um eine HTML-Hilfe 1.x-Hilfedatei (entweder eine .chm-Datei, die mit dem HTML-Hilfe-Workshop erstellt wurde, oder eine .htm-Datei) mit Ihrer Windows-Anwendung zu verbinden. 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

Indem Sie Ihrer Windows-Form eine HelpProvider-Komponente hinzufügen, können die anderen Steuerelemente im Formular die Hilfe-Eigenschaften der HelpProvider-Komponente anzeigen. Auf diese Weise können Sie Hilfe für die Steuerelemente in Ihrem Windows Form bereitstellen. Sie können der Komponente mithilfe der HelpProviderHelpNamespace Eigenschaft eine Hilfedatei zuordnen. Sie geben den Typ der Hilfe an, die durch Aufrufen SetHelpNavigator und Bereitstellen eines Werts aus der HelpNavigator Enumeration für das angegebene Steuerelement bereitgestellt wird. Sie stellen das Schlüsselwort oder thema für Hilfe bereit, 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 es nicht festgelegt wurde, müssen Sie SetHelpString verwenden, um den Hilfetext anzugeben. Wenn Sie sowohl HelpNamespace als auch die Hilfezeichenfolge festgelegt haben, hat Hilfe basierend auf HelpNamespace Vorrang.

Hinweis

Beim Angeben des Pfads zur Hilfedatei in der ShowHelp Methode oder HelpNamespace Eigenschaft des HelpProvider Steuerelements können Probleme beim Verwenden des relativen Pfads auftreten. Verwenden Sie daher unbedingt den absoluten Dateipfad, um die Hilfedatei anzugeben.

Siehe auch