Gewusst wie: Bereitstellen von Hilfe in einer Windows-Anwendung

Aktualisiert: November 2007

Sie können die HelpProvider-Komponente verwenden, um Hilfethemen in einer Hilfedatei bestimmten Steuerelementen in Windows Forms zuzuordnen. Die Hilfedatei kann entweder im Format HTML oder HTMLHelp 1.x oder höher vorliegen.

Hinweis:
Je nach den aktiven Einstellungen oder der verwendeten Version können die angezeigten Dialogfelder und Menübefehle von den in der Hilfe beschriebenen abweichen. Klicken Sie im Menü Extras auf Einstellungen importieren und exportieren, um die Einstellungen zu ändern. Weitere Informationen finden Sie unter Visual Studio-Einstellungen.

So wird die Hilfe verfügbar

1. Ziehen Sie eine HelpProvider-Komponente aus der Toolbox in das Formular.

   Die Komponente erscheint in der Taskleiste am unteren Rand des Windows Forms-Designers.

2. Legen Sie die HelpNamespace-Eigenschaft im Eigenschaftenfenster auf die CHM-, COL- oder HTM-Hilfedatei fest.

3. Aktivieren Sie ein weiteres Steuerelement, das auf dem Formular erscheint, und legen Sie die HelpKeyword-Eigenschaft im Eigenschaftenfenster fest.

   Dabei handelt es sich um die Zeichenfolge, die durch die HelpProvider-Komponente an die Hilfedatei übergeben wurde, um das entsprechende Hilfethema aufzurufen.

4. Legen Sie im Eigenschaftenfenster die HelpNavigator-Eigenschaft auf einen Wert der HelpNavigator-Enumeration fest.

   Dadurch wird festgelegt, wie die HelpKeyword -Eigenschaft an das Hilfesystem übergeben wird. In der folgenden Tabelle werden die möglichen Einstellungen und ihre Beschreibungen aufgeführt.

   Membername	Beschreibung
   AssociateIndex	Gibt an, dass der Index für ein Thema im angegebenen URL ausgeführt wurde.
   Find	Gibt an, dass die Suchseite des angegebenen URL angezeigt wird.
   Index	Gibt an, dass der Index des angegebenen URL angezeigt wird.
   KeywordIndex	Gibt ein Schlüsselwort an, nach dem gesucht wird, und die Aktion, die im angegebenen URL vorzunehmen ist.
   TableOfContents	Gibt an, dass das Inhaltsverzeichnis der HTML 1.0-Hilfedatei angezeigt wird.
   Topic	Gibt an, dass das Thema angezeigt wird, auf das durch den angegebenen URL verwiesen wird.

Wenn Sie zur Laufzeit die Taste F1 drücken und das Steuerelement, für das Sie die HelpKeyword-Eigenschaft und HelpNavigator-Eigenschaft festgelegt haben, den Fokus hat, wird die Hilfedatei geöffnet, die Sie dieser HelpProvider-Komponente zugeordnet haben.

Momentan unterstützt die HelpNamespace-Eigenschaft Hilfedateien in folgenden drei Formaten: HTMLHelp 1.x, HTMLHelp 2.0 und HTML. Dies bedeutet, dass Sie die HelpNamespace-Eigenschaft auf eine http://-Adresse (z. B. eine Web-Seite) festlegen können. Daraufhin wird im Standardbrowser die Webseite mit der Zeichenfolge geöffnet, die in der als Anker verwendeten HelpKeyword-Eigenschaft angegeben ist. Der Anker wird verwendet, um zu einem bestimmten Teil einer HTML-Seite zu springen.

Sicherheitshinweis:

Überprüfen Sie alle von einem Client gesendeten Informationen sorgfältig, bevor Sie diese in der Anwendung verwenden. Böswillige Benutzer könnten versuchen, ausführbare Skripts, SQL-Anweisungen oder anderen Code zu senden oder einzufügen. Bevor Sie die Eingabe eines Benutzers anzeigen, diese in einer Datenbank speichern oder damit arbeiten, müssen Sie sicherstellen, dass diese keine potenziell unsicheren Informationen enthält. Ein sehr gebräuchlicher Weg zur Überprüfung der von einem Benutzer übermittelten Eingaben ist die Verwendung eines regulären Ausdrucks, um nach Schlüsselwörtern wie "SCRIPT" zu suchen.

Sie können die HelpProvider-Komponente zum Anzeigen der kontextbezogenen Hilfe auch dann verwenden, wenn Sie sie zum Anzeigen der Hilfedateien für die Steuerelemente auf Windows Forms konfiguriert haben. Weitere Informationen finden Sie unter Gewusst wie: Anzeigen der kontextbezogenen Hilfe.

Siehe auch

Aufgaben

Gewusst wie: Anzeigen der kontextbezogenen Hilfe

Konzepte

Benutzerführung mithilfe von QuickInfos

Weitere Ressourcen

Integrieren von Benutzerhilfe in Windows Forms

Windows Forms