IHelpService インターフェイス

デザイン時に、ヘルプ トピックを表示し、ヘルプ キーワードの追加と削除を行うためのメソッドを提供します。

この型のすべてのメンバの一覧については、IHelpService メンバ を参照してください。

Public Interface IHelpService
[C#]
public interface IHelpService
[C++]
public __gc __interface IHelpService
[JScript]
public interface IHelpService

解説

デザイン時環境には、ユーザーが F1 キーを押したときに関連するヘルプ トピックを検索するヘルプ システムが用意されています。このヘルプ システムは、ヘルプが要求された場合に関連するトピックを指定するために使用する、現在のコンテキスト キーワードのセットを維持します。既定では、キーワードはデザイン時環境で選択されたクラス オブジェクトやオブジェクトのプロパティに関連付けられます。コンポーネントやプロパティの既定のキーワードは、そのクラスやプロパティの完全限定名です。また特定のキーワードは、複数のオブジェクトが選択されたときなど、特定のモードにも関連付けられています。カスタム ヘルプ コレクションが外部ヘルプ プロバイダに対応して構成され、デザイン時環境で統合されている場合、ドキュメント プロバイダは、特定のコンポーネントのクラスやプロパティのトピックを、その項目の完全限定型名や完全限定メンバ名で構成されたキーワードに関連付けることができます。

IHelpService を使用すると、 ShowHelpFromKeyword メソッドを使用して、指定したキーワードでヘルプ サービスを呼び出したり、 ShowHelpFromUrl メソッドを使用して、指定した URL からヘルプ トピックを呼び出すことができます。

また IHelpService を使用して、デザイン時にヘルプ キーワードの追加や削除を行うこともできます。デザイン時にコンポーネントやプロパティを選択すると、選択対象の完全限定型名や完全限定メンバ名で構成された既定の目次キーワードが設定され、以前に選択されていた (もう選択されていない) コンポーネントやプロパティのキーワードは削除されます。

ヘルプ システムは、カスタム ヘルプ キーワードを自動的に削除しないため、使用しなくなったカスタム キーワードは明示的に削除する必要があります。 ISelectionService インターフェイスで定義されるイベントを監視すると、コンポーネントの選択状態が変更されるタイミングを判断できます。これらのイベントに基づいて、コンポーネントが選択されたときにそのコンポーネントのヘルプ コンテキスト属性を追加し、選択内容からコンポーネントが外されたときにヘルプ コンテキスト属性を削除できます。

必要条件

名前空間: System.ComponentModel.Design

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System (System.dll 内)

参照

IHelpService メンバ | System.ComponentModel.Design 名前空間 | HelpKeywordType | HelpContextType