次の方法で共有

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

  • [アーティクル]

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

  • Windows フォームのコントロールに状況依存ヘルプを提供する。

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

  • 目次のメイン ページ、インデックス、検索機能など、特定の領域にヘルプ ファイルを開く。

ヘルプ プロバイダーの使用

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

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

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

注意

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

関連項目