IHelpSelector の実装

提供: RAD Studio
移動先: 案内検索

ヘルプ システムのインターフェイス への移動


警告! RAD Studio には IHelpSelector インターフェイスの実装は用意されていません。このインターフェイスのメソッドを使用するには、独自に実装する必要があります。

System.HelpIntfs.IHelpSelector は、System.HelpIntfs.ICustomHelpViewer とペアで使用するものです。指定されたキーワード、コンテキスト ID、トピック名をサポートしている、または目次を提供していると回答した登録済みのヘルプ ビューアが複数ある場合、ヘルプ マネージャはそのうちの 1 つを選択する必要があります。コンテキスト ID またはトピック名の場合、ヘルプ マネージャは、サポートしていると回答した最初のヘルプ ビューアを常に選択します。キーワードまたは目次の場合、ヘルプ マネージャは、デフォルトでは、最初のヘルプ ビューアを選択します。この動作は、アプリケーションでオーバーライドすることができます。

そのような場合にヘルプ マネージャの判断をオーバーライドするには、IHelpSelector インターフェイスを実装するクラスをアプリケーションで登録する必要があります。IHelpSelector では、SelectKeywordTableOfContents という 2 つの関数を公開しています。どちらも TStrings を引数に取ります。これらの引数には、一致する可能性のあるキーワードか、目次を提供できると回答したヘルプ ビューアの名前が格納されています。実装クラスでは、選択した文字列を表すインデックス(TStringList 内の要素を指すインデックス)を返す必要があります。その TStringList はその後、ヘルプ マネージャにより解放されます。

メモ: これらの文字列を並び替えると、ヘルプ マネージャが混乱する可能性があるので、IHelpSelector の実装クラスではそれを行わないようにすることをお勧めします。ヘルプ システムでサポートされるヘルプ セレクタは 1 つだけです。つまり、別のセレクタが新規に登録されると、既存のセレクタは関連付けが解除されます。

関連項目