方法 : ユーザー ヘルプを表示する

  • [アーティクル]

更新 : 2007 年 11 月

.NET Compact Framework には、Windows CE ヘルプ プログラム peghelp.exe にアクセスして、Pocket PC アプリケーション用のヘルプ トピックを表示するための機能があります。ヘルプ トピックを表示するには、HelpRequested イベントに対応する Windows フォームの Help クラスの ShowHelp メソッドを使用します。また、HelpEventArgs も使用できます。.NET Compact Framework では、HelpNavigator 列挙体および HelpProvider クラスをサポートしていません。

ヘルプ トピックは、1 つ以上の .htm ファイルに記述できます。Pocket PC では、コンパイル済み HTML ヘルプ (.chm) ファイルは、サポートされていません。ユーザーが [スタート] メニューの [ヘルプ] をタップすると、現在アクティブなフォームが HelpRequested イベントを受け取ります。イベントは、フォーム上のコントロールで発生するのではありません。

Smartphone アプリケーションは簡易である必要があるため、ヘルプは、Smartphone オペレーティング システムには組み込まれません。

次の表は、各ヘルプ トピックで表示されるシステム ヘルプ機能の一覧です。

メニュー項目

機能

[View]

現在のヘルプ ファイルの第 1 レベルの目次を表示する [目次] コマンド、および、インストールされているすべてのヘルプ ファイルを一覧表示する [すべてのトピック] コマンドが表示されます。

[戻る ]

現在のセッションで前に参照したトピックが表示されます。

[次に進む]

履歴リスト内の次のトピックが表示されます。

[検索]

ヘルプ トピックをキーワードで検索するための [検索] ダイアログ ボックスが表示されます。キーワードは、.htm ファイルで指定できます。

以下に示す手順では、次の処理の実行方法を示します。

  • ヘルプ トピックの .htm ファイルを作成する

  • アプリケーションのヘルプを表示する

  • ヘルプ ファイルをデバイスにインストールする

ヘルプ トピックの .htm ファイルを作成するには

  1. ヘルプに対応する名前を付けたテキスト ファイルを作成し、拡張子を .htm とします。この手順では、例として、Critters というゲーム用のヘルプを作成します。ファイルのヘッダーには、次のような META タグが必要です。

    <HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">

    各ヘルプ ファイルの最初のトピックは、"main_contents" という名前である必要があります。

  2. 検索機能用のキーワードを追加します。各キーワードはセミコロン (;) で区切ります。必要に応じて、個別のトピックにリンクする、付加的なキーワード タグを追加します。

    <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">

    トピックごとのキーワード数に制限はありません。

  3. main_contents トピックを作成します。各トピックの前には、次のコメント タグを付ける必要があります。main_contents トピックも同様です。

    <!-- PegHelp -->

    main_contents トピックには、通常、サブトピックのリンクを記述します。リンクにはアンカー名の他にファイル名も必要です。

    </head>
<body>
<!-- PegHelp -->
<a name="Main_Contents"></a>
<b>Critters Help</b>
</p>
<a href="critters.htm#overview">Game Overview</a><br>
<a href="critters.htm#options">Options</a><br>

    グラフィックも追加できますが、追加できるのは、拡張子を "2pb" に変更したビットマップ ファイルだけです。

    <img src="critter.2bp">

  4. 追加するトピックを作成します。

    2 つのトピックの間に記述する HTML の例を次に示します。

    </p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="overview">

  5. ファイルを保存し、Pocket PC の Windows ディレクトリにコピーします。

この例の HTML 全体を次に示します。

<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>
ms229662.alert_note(ja-jp,VS.90).gifメモ :

ヘルプ ファイルを使用する場合は、前のバージョンのヘルプがキャッシュされていることが原因で、最新のバージョンが参照できない場合があります。表示を更新するためには、編集しているトピック以外のヘルプ トピックを表示してから、対象のヘルプ トピックを表示し直します。

アプリケーションのヘルプを表示するには

  • Pocket PC でヘルプを参照するには、[スタート] メニューの [ヘルプ] をタップします。Windows CE では、HelpRequested イベントに対応して ShowHelp メソッドが呼び出されていると仮定して、現在表示されているアプリケーションのヘルプ トピックが表示されます。

    ShowHelp を使用して、ボタンをクリックしたときなどに、アプリケーション内からヘルプを呼び出すこともできます。各方法でのヘルプ トピックの呼び出し方を示すコード例を次に示します。ShowHelp メソッドの最初のパラメータは、親コントロールです。このパラメータは、Pocket PC には関連がありませんが、.NET Framework との互換性を完全にするために用意されています。

    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);
    }
}

ヘルプ ファイルをデバイスにインストールするには

  1. システムにインストールされている他のヘルプと一緒に一覧に表示されるように、ヘルプ システム用のショートカット ファイルを作成します。テキスト エディタで次の構文を使用して、ヘルプのパスを記述したファイルを作成します。

    14#\windows\critters.htm

    パスの前には、パスの文字数とシャープ記号 (#) を付けます。ファイルにはこの行だけを記述します。この例では、Critters ゲーム用のヘルプが表示されます。

  2. ヘルプ ファイルと同じ名前を使用し、拡張子だけを .lnk に変えて、\Windows\Help フォルダにファイルを保存します。

  3. [スタート] メニューの [ヘルプ] をタップします。作成したヘルプが表示されない場合には、[View] メニューの [すべてのトピック] をクリックします。作成したヘルプが、一覧でアルファベット順に並んだ位置に表示されます。

参照

概念

.NET Compact Framework に関する「方法」トピック

その他の技術情報

.NET Compact Framework の Windows フォーム コントロール