方法 : Windows アプリケーションにヘルプを提供する
更新 : 2007 年 11 月
HelpProvider コンポーネントを使用すると、ヘルプ ファイル内のヘルプ トピックを Windows フォームの特定のコントロールに追加できます。ヘルプ ファイルの形式には、HTML または HTMLHelp 1.x 以上を指定できます。
.gif "メモ") メモ : |
|---|
使用している設定またはエディションによっては、表示されるダイアログ ボックスやメニュー コマンドがヘルプに記載されている内容と異なる場合があります。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。 |
ヘルプを提供するには
ツールボックスから、フォームに HelpProvider コンポーネントをドラッグします。
コンポーネントは、Windows フォーム デザイナの下部にあるトレイに配置されます。
[プロパティ] ウィンドウで、HelpNamespace プロパティを .chm、.col、または .htm ヘルプ ファイルに設定します。
フォーム上の他のコントロールを選択し、[プロパティ] ウィンドウで HelpKeyword プロパティを設定します。
これは、適切なヘルプ トピックを呼び出すために HelpProvider コンポーネントによってヘルプ ファイルに渡される文字列です。
[プロパティ] ウィンドウで、HelpNavigator プロパティを HelpNavigator 列挙定数の値に設定します。
これにより、HelpKeyword プロパティがヘルプ システムに渡される方法が決まります。設定できるオプションとその説明を次の表に示します。
メンバ名
説明
AssociateIndex
指定したトピックのインデックスを指定した URL で実行するように指定します。
Find
指定した URL の検索ページを表示するように指定します。
Index
指定した URL のインデックスを表示するように指定します。
KeywordIndex
検索するキーワードと、指定した URL で実行するアクションを指定します。
TableOfContents
HTML 1.0 ヘルプ ファイルの目次を表示するように指定します。
Topic
指定した URL によって参照されるトピックを表示するように指定します。
実行時に、HelpKeyword プロパティおよび HelpNavigator プロパティを設定したコントロールにフォーカスがある状態で F1 キーを押すと、HelpProvider コンポーネントに関連付けられたヘルプ ファイルが開きます。
現在、HelpNamespace プロパティは HTMLHelp 1.x、HTMLHelp 2.0、および HTML の 3 つの形式のヘルプ ファイルをサポートしています。したがって、HelpNamespace プロパティには http:// アドレス (Web ページなど) を設定できます。プロパティに http:// アドレスを設定すると、既定のブラウザが開き、HelpKeyword プロパティに指定した文字列をアンカーとして使用して Web ページが表示されます。アンカーは HTML ページの特定の部分にジャンプするために使用されます。
.gif "セキュリティに関するメモ") セキュリティに関するメモ : |
|---|
クライアントから送信された情報は、アプリケーションで使用する前に必ずチェックしてください。悪意のあるユーザーが、実行可能スクリプトや SQL ステートメントなどのコードの送信 (挿入) を試みる場合があります。ユーザーからの入力を表示したり、データベースに格納したり、操作したりする前に、安全でない可能性のある情報が含まれていないかどうかを確認してください。一般的な確認方法としては、ユーザーから入力を受け取ったときに、正規表現を使用して、"SCRIPT" などのキーワードを検索します。 |
Windows フォーム上のコントロールに対してヘルプ ファイルを表示するように HelpProvider コンポーネントを設定した場合でも、このコンポーネントを使用してポップアップ ヘルプを表示できます。詳細については、「方法 : ポップアップ ヘルプを表示する」を参照してください。