[HelpProvider][Tips] ヘルプファイルのどの要素を表示するかを設定する

2011.12.14

[ad#ad-336×280]
SetHelpNavigatorメソッドを使用すると、ヘルプファイルを開くときに、どの要素を表示するかを設定することができます。

第1引数にはコントロールを、第1引数にはどの要素を表示するかを設定します。要素にはHelpNavigator列挙体の値を指定します。

HelpNavigator列挙体

メンバー名	説明
Topic	ヘルプファイルに指定したトピックが存在する場合は、そのトピックを表示する
TableOfContents	ヘルプファイルの目次が表示される
Index	ヘルプファイルのインデックスが表示される
Find	ヘルプファイルの検索ページが表示される
AssociateIndex	指定したトピックの最初の文字インデックスエントリが表示される
KeywordIndex	指定されたインデックスエントリを持つトピックが存在する場合はトピックを表示し、存在しない場合は指定したキーワードに最も近いインデックスエントリを持つトピックが表示される
Topicid	トピックの数値識別子で指定されたトピックが表示される

下記は、ヘルプファイルのどの要素を表示するかを設定する例です。

TableOfContentsを指定して目次を表示するようにしています。

VBの例

' フォームロード時の処理
Private Sub Form2_Load(sender As System.Object, e As System.EventArgs) Handles MyBase.Load
    'ヘルプファイルを設定する
    HelpProvider1.HelpNamespace = "C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\Tools\spyxx.chm"
    'キーワードに"s"を設定
    HelpProvider1.SetHelpKeyword(TextBox1, "s")
    '★★★目次を開く★★★
    HelpProvider1.SetHelpNavigator(TextBox1, HelpNavigator.TableOfContents)
End Sub

C#の例

// フォームロード時の処理
private void Form2_Load(object sender, EventArgs e)
{
    // ヘルプファイルを設定する
    helpProvider1.HelpNamespace = @"C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\Tools\spyxx.chm";
    // キーワードに"s"を設定
    helpProvider1.SetHelpKeyword(textBox1, "s");
    // ★★★目次を開く★★★
    helpProvider1.SetHelpNavigator(textBox1, HelpNavigator.TableOfContents);
}

Please follow and like us: