|
|
  |
Hilfe für ein Formular, einen Dialog oder ein Steuerelement mit HTML Dateien erstellen
 |
Eigenschaften für die Anzeige von Hilfe (HTML Datei - lokal) |
|
Eigenschaften für die Anzeige von Hilfe (HTML Datei - Server http://..) |
Hilfe für ein Formular, einen Dialog oder ein Steuerelement mit lokaler CHM Datei erstellen
Windows Forms unterstützt bei einzelnen Steuerelementen einen "What's this .." HelpButton und / oder F1-Hilfe die auf Hilfedateien basieren. Um Hilfethemen innerhalb einer Hilfedatei (das sind entweder HTML oder HTMLHelp 1.x / Help 2.x Format) zu bestimmten Steuerelementen über Windows Forms zuzuordnen müssen Sie die HelpProvider Komponente verwenden. Die HelpProvider Komponente wird entweder eine HTMLHelp 1.x Hilfedatei (CHM) oder eine einzelne HTML Datei mit Ihrer Windows Forms Anwendung verbinden.
Dieser Hilfebutton befindet sich auf der rechten Seite der Titelzeile und auf ihn kann durch die HelpButton Eigenschaften zugegriffen werden. Damit der Hilfebutton auf Ihrem Formular angezeigt wird, ist es erforderlich die MinimizeBox und MaximizeBox Eigenschaft des Formulars auf "False" und die HelpButton Eigenschaft auf "True" zu setzen.
Um diese Hilfe in Ihrer Anwendung zu unterstützen, müssen Sie die HelpProvider Komponente aus der Toolbox der Windows Forms Registerkarte verwenden. Ziehen Sie eine HelpProvider Komponente aus der Toolbox auf Ihr Formular. Es ist eine Komponente statt einem Steuerelement, so dass es nach dem Ziehen auf Ihr Formular unten im Komponentenrahmen sitzt. Benennen Sie diese Komponente in "hlpHtmlLocal" um. Diese Komponente gibt jedem Steuerelement auf der Form drei neue Eigenschaften, die HelpKeyword, HelpNavigator und HelpString auf hlpProvider1 heißen.
Wenn notwendig (z.B. mein Beispiel) ziehen Sie zwei weitere HelpProvider Komponenten auf Ihr Formular und benennen Sie diese in "hlpProvider1" und "hlpHtmlServer" um.
Aktivieren Sie die hlpProvider Komponente hlpHtmlLocal und stellen Sie die HelpNameSpace Eigenschaft von hlpHtmlLocal auf den Dateinamen ein, mit dem Sie arbeiten wollen.
Wir öffnen mit dem Dialog, durch Verwendung des kleinen Button an der rechten Seite, eine lokal gespeicherte HTML Datei.
Der nächste Schritt soll die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator Enumerations (siehe Tabelle unten) setzen. Hier verwenden wir Topic.
Wenn die Anwendung läuft, klicken Sie den HelpButton um die "What's this .." Hilfe zu aktivieren. Der Mauszeiger ändert sich. Jetzt klicken Sie den Button oder drücken Sie F1, wenn der Button Fokus hat. Dies öffnet die einzelne HTML Datei in Ihrem Browser.
Anscheinend kann man keine Ankernamen verwenden, um an einen bestimmten Teil Ihrer HTML Datei zu springen!
Aktivieren Sie die hlpProvider Komponente hlpHtmlLocal und stellen Sie die HelpNameSpace Eigenschaft von hlpHtmlServer auf den Dateinamen ein, mit dem Sie arbeiten wollen. Hier verwenden wir eine http:// Adresse einer einzelnen HTML Datei. Wenn Sie die Datei über Ihren Firmenserver bereitstellen, müssen Sie die Hilfedatei nicht beim Kunden aktualisieren.
Der nächste Schritt soll die HelpNavigator Eigenschaft eines Steuerelements (z.B. Button) auf einem Wert der HelpNavigator-Enumerations (siehe Tabelle unten) einstellen. Hier verwenden wir Topic. Dann setzen wir die HelpKeyword auf hlpHtmlSever Eigenschaft auf z.B. "anchor3". Fügen Sie kein führendes "#" hinzu. Lassen Sie es leer, wenn Sie eine HTML Datei ohne Anker öffnen wollen. Die HelpKeyword Eigenschaft liefert die Schlüsselinformation, um die mit dem Steuerelement verbundene Hilfe wieder aufzufinden.
Wenn die Anwendung läuft, klicken Sie den HelpButton um die "What's this .." Hilfe zu aktivieren. Der Mauszeiger ändert sich. Jetzt klicken Sie den Button oder drücken Sie F1, wenn der Button Fokus hat. Dies öffnet die einzelne HTML Datei über das Internet in Ihrem Browser.
Aktivieren Sie die hlpProvider Komponente und stellen Sie die HelpNameSpace Eigenschaft von hlpProvider1 auf den Dateinamen ein, mit dem Sie arbeiten wollen. Hier verwenden wir eine CHM Datei. CHM Dateien sind in einem komprimierten ITStorage Format, das vom Microsoft HTMLHelp Workshop verwendet wird.
Private Sub cmdControl2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) _
Handles cmdControl2.Click
Dim sHelpFile As String
Dim sStartupPath As String
'--- Initialize context-sensitive help ---
sStartupPath = Application.StartupPath.ToString
sHelpFile = Replace(sStartupPath, "\bin", "\hlp") & "\VBnetCHM.chm"
Me.hlpProvider1.HelpNamespace = sHelpFile
Me.hlpProvider1.SetHelpNavigator(Me.cmdControl1, HelpNavigator.KeywordIndex)
Me.hlpProvider1.SetHelpKeyword(Me.cmdControl1, "Help topic of control 1")
End Sub
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button:
Hinweis: Der Aufruf ist von der aktuell geöffneten Registerkarte (Inhalt oder Index) beim letzten Schließen des CHM Hilfefensters abhängig.
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button:
Beachten Sie bitte weitere technische Informationen.
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button:
Hinweis: Klicken Sie "Anzeigen", um das Thema im Inhaltsteilfenster zu sehen.
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button:
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button.
Stellen Sie die HelpNavigator Eigenschaft eines Steuerelements (z.B. ein Button) auf einen Wert der HelpNavigator-Enumerations (siehe Tabelle unten).
Um folgende Ergebnisse vom Beispiel zu bekommen, klicken Sie auf die F1 Taste, wenn der Button Fokus hat, oder klicken den HelpButton und dann klicken den entsprechenden Button.
Die HelpNavigator Eigenschaft ist eine Aufzählung, die die Verwwendung des Hilfe Kommandos spezifiziert, wenn die Hilfe für das angegebene Steuerelement in der Hilfedatei wiedergefunden werden muß.
| HelpNavigator Eigenschaft |
Beschreibung |
| AssociateIndex | Zeigt den Index an und positioniert auf das erste vorhandene Schlüsselwort, dass mit dem Buchstaben beginnt. Der Buchstabe leitet sich aus dem ersten Buchstaben des Wortes in der HelpKeyword Eigenschaft ab. |
| Find | Zeigt die Registerkarte Suchen an. Irgendein Text (?) ist in der HelpKeyword Eigenschaft zwingend! |
| Index | Zeigt den Index an und positioniert auf das Schlüsselwort. Das Schlüsselwort wird in der HelpKeyword Eigenschaft angegeben. |
| KeywordIndex | Zeigt das Inhaltsverzeichnis an, positioniert auf das Thema und zeigt das verknüpfte Thema im Inhaltsfenster. Das Thema wird mit dem Schlüsselwort gesucht, welches in der HelpKeyword Eigenschaft angegeben ist. |
| TableOfContents | Zeigt Table of Contents (TOC) Die HelpKeyword Eigenschaft ist nicht zwingend notwendig! |
| Topic | Zeigt das Thema, worauf vom angegebenen URL verwiesen wird. |
| TopicId | Dieser Wert wird erst mit .NET 2.0 verfügbar. |
Wenn Sie kein Visual Studio NET besitzen aber das Microsoft NET Framework 1.0 installiert haben (z.B. von der CD-Version des Windows XP SP1) können Sie das Beispiel für Visual Basic 2002 entpacken und die Datei VBnetCHM.exe im Unterverzeichnis "../bin" doppelklicken.
 |