Zum Inhalt

AppHelp

Pop-Up Hilfe für VB.net Steuerelemente erstellen

Eine Möglichkeit, Hilfe in Windows Forms anzuzeigen, ist die Schaltfläche „Hilfe“ (Fragezeichen) auf der rechten Seite der Titelleiste, auf die über die Eigenschaft „HelpButton“ zugegriffen werden kann. Diese Art der Hilfeanzeige eignet sich gut für die Verwendung mit Dialogfeldern. Bei modal angezeigten Dialogfeldern (mit der Methode „ShowDialog“) gibt es Probleme beim Aufrufen externer Hilfesysteme, da modale Dialogfelder geschlossen werden müssen, bevor der Fokus auf ein anderes Fenster verschoben werden kann. Außerdem darf bei Verwendung der Schaltfläche „Hilfe“ keine Schaltfläche zum Minimieren oder Maximieren in der Titelleiste angezeigt werden. Dies ist eine Standardkonvention für Dialogfelder, während Formulare in der Regel über Schaltflächen zum Minimieren und Maximieren verfügen.

Drücken Sie in einer laufenden App die Hilfe-Schaltfläche (Fragezeichen) in der Titelleiste und klicken Sie auf das Steuerelement, für das Sie die Hilfe-Zeichenfolge festgelegt haben.

Sie können auch die HelpProvider-Komponente verwenden, um Steuerelemente mit Dateien in einem Hilfesystem zu verknüpfen, selbst wenn Sie eine Popup-Hilfe implementiert haben. Weitere Informationen finden Sie unter Bereitstellen von Hilfe in einer Windows-Anwendung.

Pop-Up AppHelp

Ziehen Sie in Visual Studio eine HelpProvider-Komponente aus der Toolbox auf Ihr Formular. Sie wird in der Leiste am unteren Rand des Windows Forms Designers angezeigt.

Pop-Up AppHelp

Setzen Sie im Eigenschaftenfenster die Eigenschaft HelpButton auf true. Dadurch wird auf der rechten Seite der Titelleiste des Formulars eine Schaltfläche mit einem Fragezeichen angezeigt.

Damit die Schaltfläche „HelpButton“ angezeigt wird, müssen die Eigenschaften MinimizeBox und MaximizeBox des Formulars auf false gesetzt sein, die Eigenschaft ControlBox auf true und die Eigenschaft FormBorderStyle auf einen der folgenden Werte: „FixedSingle“, „Fixed3D“, „FixedDialog“ oder „Sizable“.

Pop-Up AppHelp

Wählen Sie das Steuerelement aus, für das Sie Hilfe in Ihrem Formular anzeigen möchten, und legen Sie die Hilfezeichenfolge im Eigenschaftenfenster fest. Dies ist die Textzeichenfolge, die in einem Fenster ähnlich einem Tooltip angezeigt wird.

Pop-Up code snippets

' set up pop-up text for controls
HelpProvider1.SetShowHelp(Me.txtPopUp, True)
HelpProvider1.SetHelpString(Me.txtPopUp, "Enter some text into this text field and press the 'Save' button to change this text.")
HelpProvider1.SetShowHelp(Me.cmdPopUpTextClear, True)
HelpProvider1.SetHelpString(Me.cmdPopUpTextClear, "Press the 'Clear' button to reset the text field.")
HelpProvider1.SetShowHelp(Me.cmdPopUpTextSave, True)
HelpProvider1.SetHelpString(Me.cmdPopUpTextSave, "Press the 'Save' button to save the text as the new Pop-Up text.")

Speichern Sie den Text als neuen HelpString, indem Sie die SetHelpString-Eigenschaft festlegen:

Private Sub cmdPopUpTextSave_Click(sender As Object, e As EventArgs) Handles cmdPopUpTextSave.Click
    HelpProvider1.SetHelpString(Me.txtPopUp, Me.txtPopUp.Text)
End Sub

Deaktivieren Sie die Popup-Meldung für dieses Steuerelement, indem Sie die Eigenschaft SetShowHelp auf „False“ setzen:

Private Sub chkShowPopUpHelp_CheckedChanged(sender As Object, e As EventArgs) Handles chkShowPopUpHelp.CheckedChanged
    If chkShowPopUpHelp.Checked = True Then
        HelpProvider1.SetHelpString(Me.cmdPopUpTextClear, "Press the 'Clear' button to reset the text field.")
    Else
        HelpProvider1.SetShowHelp(Me.cmdPopUpTextClear, False)
    End If
End Sub