Freigeben über

Vorgehensweise: Bereitstellen von Hilfe in einer Windows-Anwendung

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

Hilfe anbieten

  1. Ziehen Sie in Visual Studio aus der Toolbox eine HelpProvider-Komponente in Ihr Formular.

    Die Komponente befindet sich im Infobereich unten im Windows Forms-Designer.

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

  3. Wählen Sie ein anderes Steuerelement aus, das Sie in Ihrem Formular haben, und legen Sie im Fenster Eigenschaften die eigenschaft SetHelpKeyword fest.

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

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

    Dies bestimmt die Art, wie die HelpKeyword-Eigenschaft an das Hilfesystem übergeben wird. In der folgenden Tabelle sind die möglichen Einstellungen und deren Beschreibungen aufgeführt.

    Mitgliedsname BESCHREIBUNG
    AssociateIndex Gibt an, dass der Index für ein angegebenes Thema in der angegebenen URL ausgeführt wird.
    Suchen Gibt an, dass die Suchseite einer angegebenen URL angezeigt wird.
    Verzeichnis Gibt an, dass der Index einer angegebenen URL angezeigt wird.
    Schlüsselwortindex Gibt ein Schlüsselwort an, nach dem gesucht werden soll, und die Aktion, die in der angegebenen URL ausgeführt werden soll.
    Inhaltsverzeichnis Gibt an, dass das Inhaltsverzeichnis der HTML 1.0-Hilfedatei angezeigt wird.
    Thema Gibt an, dass das Thema, auf das durch die angegebene URL verwiesen wird, angezeigt 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.

Derzeit unterstützt die HelpNamespace-eigenschaft Hilfedateien in den 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 Webseite) 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.

Von Bedeutung

Achten Sie darauf, alle Informationen zu überprüfen, die von einem Client gesendet werden, bevor Sie sie in Ihrer Anwendung verwenden. Böswillige Benutzer versuchen möglicherweise, ausführbare Skripts, SQL-Anweisungen oder anderen Code zu senden oder einzugeben. Bevor Sie die Eingabe eines Benutzers anzeigen, sie in einer Datenbank speichern oder damit arbeiten, überprüfen Sie, ob sie keine potenziell unsicheren Informationen enthält. Eine typische Möglichkeit zur Überprüfung besteht darin, einen regulären Ausdruck zu verwenden, um nach Schlüsselwörtern wie "SCRIPT" zu suchen, wenn Sie Eingaben von einem Benutzer erhalten.

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 in Windows Forms konfiguriert haben. Weitere Informationen finden Sie unter Anzeigen der kontextbezogenen Hilfe.

Siehe auch

  • Last updated on