HelpProvider コンポーネントの概要 (Windows フォーム)

更新 : 2007 年 11 月

Windows フォームの HelpProvider コンポーネントは、HTML Help 1.x ヘルプ ファイル (HTML Help Workshop で生成した .chm ファイル、または .htm ファイル) を Windows アプリケーションに関連付けるために使用します。ヘルプを用意するにはさまざまな方法があります。

• Windows フォームのコントロールに状況依存のヘルプを用意します。

• 特定のダイアログ ボックスまたはダイアログ ボックス内の特定のコントロールに状況依存のヘルプを用意します。

• 目次、索引、検索機能のメイン ページなど、ヘルプ ファイルの特定の領域を開きます。

HelpProvider の使用

HelpProvider コンポーネントを Windows フォームに追加すると、フォーム上のその他のコントロールで HelpProvider コンポーネントのヘルプ プロパティを公開できます。これによって、Windows フォーム上にコントロールのヘルプを表示できます。HelpProvider コンポーネントにヘルプ ファイルを関連付けるには、HelpNamespace プロパティを使用します。SetHelpNavigator を呼び出し、特定のコントロールの HelpNavigator 列挙体の値を指定することによって、提供されるヘルプの種類を指定します。SetHelpKeyword メソッドを呼び出して、ヘルプのキーワードまたはトピックを指定します。

また、特定のヘルプ文字列を他のコントロールに関連付けるには、SetHelpString メソッドを使用します。コントロールにフォーカスがあるときに F1 キーを押すと、コントロールに関連付けた文字列がポップアップ ウィンドウに表示されます。

HelpNamespace が設定されていない場合は、SetHelpString を使用してヘルプ テキストを用意する必要があります。HelpNamespace とヘルプ文字列の両方が設定されている場合は、HelpNamespace のヘルプが優先されます。

メモ :
ShowHelp メソッドまたは HelpProvider コントロールの HelpNamespace プロパティでヘルプ ファイルへのパスを指定する場合に相対パスを使用すると、問題が生じることがあります。したがって、ヘルプ ファイルを指定する場合は、必ず絶対ファイル パスを使用してください。

参照

概念

Windows フォーム アプリケーションのヘルプ システム