次の方法で共有

方法: Windows アプリケーションにヘルプを提供する

  • [アーティクル]

HelpProvider コンポーネントを使用すると、ヘルプ ファイル内のヘルプ トピックを Windows フォームの特定のコントロールに追加できます。 ヘルプ ファイルの形式には、HTML または HTMLHelp 1.x 以上を指定できます。

ヘルプを提供する

  1. Visual Studio のツールボックスから、HelpProvider コンポーネントをフォームにドラッグします。

    コンポーネントは、Windows フォーム デザイナーの下部にあるトレイに配置されます。

  2. [プロパティ] ウィンドウで、HelpNamespace プロパティを .chm、.col、または .htm のヘルプ ファイルに設定します。

  3. フォーム上の別のコントロールを選択し、 [プロパティ] ウィンドウで SetHelpKeyword プロパテを選択します。

    これは、適切なヘルプ トピックを呼び出すために HelpProvider コンポーネントによってヘルプ ファイルに渡される文字列です。

  4. [プロパティ] ウィンドウで、SetHelpNavigator プロパティを HelpNavigator 列挙体の値に設定します。

    これにより、HelpKeyword プロパティがヘルプ システムに渡される方法が決まります。 設定できるオプションとその説明を次の表に示します。

    メンバー名 [説明]
    AssociateIndex 指定したトピックのインデックスを指定した URL で実行するように指定します。
    Find 指定した URL の検索ページを表示するように指定します。
    インデックス 指定した URL のインデックスを表示するように指定します。
    KeywordIndex 検索するキーワードと、指定した URL で実行するアクションを指定します。
    TableOfContents HTML 1.0 ヘルプ ファイルの目次を表示するように指定します。
    トピック 指定した URL によって参照されるトピックを表示するように指定します。

実行時に、HelpKeyword プロパティおよび HelpNavigator プロパティを設定したコントロールにフォーカスがある状態で F1 キーを押すと、HelpProvider コンポーネントに関連付けられたヘルプ ファイルが開きます。

現在、HelpNamespace プロパティは HTMLHelp 1.x、HTMLHelp 2.0、および HTML の 3 つの形式のヘルプ ファイルをサポートしています。 したがって、HelpNamespace プロパティには http:// アドレス (Web ページなど) を設定できます。 プロパティに http:// アドレスを設定すると、既定のブラウザーが開き、HelpKeyword プロパティに指定した文字列をアンカーとして使用して Web ページが表示されます。 アンカーは HTML ページの特定の部分にジャンプするために使用されます。

重要

クライアントから送信された情報は、アプリケーションで使用する前に必ずチェックしてください。 悪意のあるユーザーが、実行可能スクリプトや SQL ステートメントなどのコードの送信 (挿入) を試みる場合があります。 ユーザーからの入力を表示したり、データベースに格納したり、操作したりする前に、安全でない可能性のある情報が含まれていないかどうかを確認してください。 一般的な確認方法としては、ユーザーから入力を受け取ったときに、正規表現を使用して、"SCRIPT" などのキーワードを検索します。

Windows フォーム上のコントロールに対してヘルプ ファイルを表示するように HelpProvider コンポーネントを設定した場合でも、このコンポーネントを使用してポップアップ ヘルプを表示できます。 詳細については、「方法: ポップアップ ヘルプを表示する」を参照してください。

関連項目