Gewusst wie: Anzeigen der Benutzerhilfe

Artikel
09/02/2008

Aktualisiert: November 2007

.NET Compact Framework bietet Zugriff auf das Windows CE-Hilfeprogramm, peghelp.exe, um Hilfethemen für Pocket PC-Anwendungen anzuzeigen. Sie können zum Anzeigen eines Hilfethemas als Reaktion auf das HelpRequested-Ereignis die ShowHelp-Methode der Help-Klasse von Windows Forms und HelpEventArgs verwenden. Die HelpNavigator-Enumeration und die HelpProvider-Klasse werden in .NET Compact Framework nicht unterstützt.

Hilfethemen können in einer oder mehreren HTM-Dateien enthalten sein. Kompilierte HTML-Dateien, d. h. CHM-Dateien, werden auf dem Pocket PC nicht unterstützt. Wenn der Benutzer das Startmenü aufruft und Hilfe auswählt, empfängt das aktuell aktive Formular das HelpRequested-Ereignis. Von Steuerelementen im Formular wird das Ereignis nicht ausgelöst.

Die Hilfe ist nicht ins Smartphone-Betriebssystem integriert, da Smartphone-Anwendungen einfach sein sollen.

In der folgenden Tabelle werden die für jedes Thema angezeigten Hilfefeatures des Systems aufgelistet.

Menüelement	Funktion
Ansicht	Bietet Zugriff auf den Befehl Inhalt, mit dem die erste Inhaltsebene der aktuellen Hilfedatei angezeigt wird, sowie auf den Befehl Gesamte installierte Hilfe, mit dem eine Liste aller installierten Hilfedateien angezeigt wird.
Zurück	Zeigt das in der aktuellen Sitzung zuvor angezeigte Thema an.
Weiter	Zeigt das nächste Thema in der Verlaufsliste an.
Suchen	Öffnet das Dialogfeld Suchen, indem anhand von Schlüsselwörtern nach Hilfethemen gesucht werden kann. Sie können Schlüsselwörter in den HTM-Dateien angeben.

In den folgenden Verfahren werden diese Aufgaben veranschaulicht:

So erstellen Sie eine HTM-Datei der Hilfethemen
So zeigen Sie Hilfe zur Anwendung an
So installieren Sie die Hilfedatei auf dem Gerät

So erstellen Sie eine HTM-Datei der Hilfethemen

Erstellen Sie eine Textdatei mit einem aussagekräftigen Namen für die Hilfe und der Erweiterung .htm. In diesem Verfahren wird beispielhaft die Hilfe für ein Spiel mit dem Namen Critters erstellt. Die Datei muss über das folgende META-Tag im Header verfügen:
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
Das erste Thema in jeder Hilfedatei muss den Namen "main_contents" erhalten.
Fügen Sie Schlüsselwörter für das Programm Suchen hinzu. Trennen Sie die Schlüsselwörter durch Semikolons voneinander. Fügen Sie nach Bedarf zusätzliche Keyword-Tags für Links zu bestimmten Themen hinzu.
```
<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
 HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
 HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
 HREF="Critters.htm#options">
```
Sie können beliebig viele Schlüsselwörter für ein Thema festlegen.
Erstellen Sie das Thema main_contents. Vor jedem Thema, auch vor main_contents, muss das folgende Kommentartag angegeben werden:
```

```
Das Thema main_contents enthält i. d. R. Links zu untergeordneten Themen. Beachten Sie, dass für Links neben dem Anchornamen auch der Dateiname erforderlich ist.
```
</head>
<body>

<a name="Main_Contents"></a>
Critters Help

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
Sie können Grafiken hinzufügen, allerdings nur Bitmaps, die umbenannt werden müssen, damit sie die Erweiterung "2pb" aufweisen.
```
<img src="critter.2bp">
```
Erstellen Sie weitere Themen.

Im Folgenden wird der HTML-Code zwischen zwei Themen dargestellt:
```



<hr>
<a name="overview">
```
Speichern Sie die Datei, und kopieren Sie sie ins Windows-Verzeichnis des Pocket PCs.

Der vollständige HTML-Code für dieses Beispiel lautet wie folgt:

<html>
<head>
<META HTTP-EQUIV="Htm-Help" Content="critters.htm#Main_Contents">
<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
  HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
  HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
  HREF="Critters.htm#options">
</head>
<body>
<!-- PegHelp -->
<p>
<a name="Main_Contents"></a>
</p>
<b>Critters Help</b>
</p>
<p>
<a href="critters.htm#overview">Game Overview</a><br>
<a href="critters.htm#options">Game Options</a><br>
<img src="critter.2bp">
</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="overview"></a>
<p><b>Game Overview</b></p>
<p>Critters are small round creatures that you can adopt and raise.  
  They have various moods and characteristics and each one has its own 
  personality and appearance that will change over time.</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="options"></a>
<p><b>Options</b></p>
<ul>
<li><i>Sound</i> – Turn sound on / off</li>
<li><i>Sub-Games</i> – Turn sub-games on / off.  When a caretaker 
  attempts to play with a critter or teach a critter, sub-games are 
  presented such as ‘Guess my number’ and ‘Trivia’ if this option is 
  checked.</li>
<li><i>Animation</i> – Turn animation on / off.  Turning this off will 
  cause the critter to remain still.</li>
<li><i>Notifications</i> – Choose icon / text / none.  Notifications 
  appear to inform you when your critter is in danger of dying due to 
  a particular need not being met.</li>
<li><i>Speed</i> – This is the rate at which the game engine operates.
  It affects how fast feelings develop and statistics are 
  modified.</li>
</ul>
</p>
</body>
</html>

Hinweis:
Wenn Sie mit Hilfedateien arbeiten, befindet sich im Cache möglicherweise eine frühere Version der Hilfe, was dazu führt, dass die neuesten Aktualisierungen nicht angezeigt werden. Zeigen Sie zum Aktualisieren der Anzeige zunächst ein anderes Hilfethema und dann erneut das Hilfethema an, an dem Sie gerade arbeiten.

So zeigen Sie Hilfe zur Anwendung an

Tippen Sie zum Anzeigen der Hilfe auf dem Pocket PC auf den Befehl Hilfe im Startmenü. Windows CE zeigt das Hilfethema für die aktuell angezeigte Anwendung an, vorausgesetzt, Sie haben als Reaktion auf das HelpRequested-Ereignis die ShowHelp-Methode aufgerufen.

Sie können ShowHelp auch verwenden, um innerhalb der Anwendung die Hilfe aufzurufen, z. B. durch Klicken auf eine Schaltfläche. Im folgenden Codebeispiel wird das Aufrufen der Hilfe in beiden Fällen veranschaulicht. Beachten Sie, dass der erste Parameter für die ShowHelp-Methode das übergeordnete Steuerelement ist. Dieser Parameter ist für den Pocket PC nicht relevant, wird jedoch zur Gewährleistung der Kompatibilität mit dem vollständigen .NET Framework bereitgestellt.

Protected Overrides Sub OnHelpRequested(ByVal hlpevent As HelpEventArgs) 
    ' The HelpRequested event occurs when
    ' the user taps Help on the Start menu.
    Help.ShowHelp(Me, "\windows\myAppHelp.htm#Main_Contents")
    MyBase.OnHelpRequested(hlpevent)

End Sub
Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles button1.Click
    ' You can also show Help
    ' for a subtopic
    ' by clicking a button.
    Try
        Help.ShowHelp(Me, "\windows\myappHelp.htm#overview")
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

protected override void OnHelpRequested(HelpEventArgs hlpevent)
{
    // The HelpRequested event occurs when
    // the user taps Help on the Start menu.
    Help.ShowHelp(this,@"\windows\myAppHelp.htm#Main_Contents");
    base.OnHelpRequested(hlpevent);
}

private void button1_Click(object sender, System.EventArgs e)
{
    // You can also show Help
    // for a subtopic
    // by clicking a button.
    try
    {
        Help.ShowHelp(this,@"\windows\myappHelp.htm#overview");
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

So installieren Sie die Hilfedatei auf dem Gerät

Erstellen Sie eine Verknüpfungsdatei, damit das Hilfesystem die Hilfe zusammen mit der übrigen im System installierten Hilfe auflistet. Erstellen Sie in einem Text-Editor eine Datei mit einem Pfad zu der von Ihnen erstellten Hilfedatei. Verwenden Sie dazu die folgende Syntax:
```
14#\windows\critters.htm
```
Vor dem Pfad wird die Anzahl von Zeichen im Pfad und das Nummernzeichen (#) angegeben. Die Datei sollte keine weiteren Zeilen enthalten. In diesem Beispiel wird die Hilfe für das Spiel Critters angezeigt.
Speichern Sie die Datei unter demselben Namen wie die Hilfe und mit der Erweiterung .lnk im Ordner \Windows\Help.
Tippen Sie im Startmenü auf Hilfe. Sofern die Hilfe nicht bereits angezeigt wird, wählen Sie im Menü Ansicht die Option Gesamte installierte Hilfe aus. Die neu erstellte Hilfe sollte in der alphabetisch sortierten Liste an der richtigen Position angezeigt werden.

Freigeben über

Gewusst wie: Anzeigen der Benutzerhilfe

So erstellen Sie eine HTM-Datei der Hilfethemen

So zeigen Sie Hilfe zur Anwendung an

So installieren Sie die Hilfedatei auf dem Gerät

Siehe auch

Konzepte

Weitere Ressourcen

Zusätzliche Ressourcen