ヘルプ マネージャとの通信

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

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


System.HelpIntfs.ICustomHelpViewer には、ヘルプ マネージャとシステム情報をやり取りするのに使用できる以下の 4 つの関数が用意されています。ヘルプ マネージャは、下記の状況でこれらの関数を呼び出します。

  • GetViewerName: String -- ヘルプ マネージャがヘルプ ビューアの名前を知る必要がある場合に呼び出されます(たとえば、すべての登録済みヘルプ ビューアのリストを表示するようにアプリケーションに要求する場合など)。この情報は String 型の戻り値で返されますが、論理的に静的でなければなりません(つまり、アプリケーションの動作中は変更できません)。
  • NotifyID(const ViewerID: Integer) -- 登録後すぐに呼び出され、ヘルプ ビューアを識別する一意なクッキーをヘルプ ビューアに提供します。この情報は、後で使用できるように保存しておく必要があります。つまり、ヘルプ ビューアでは、(ヘルプ マネージャからの通知に応答してではなく)自分から停止する場合は、自分自身を識別するクッキーをヘルプ マネージャに渡して、ヘルプ マネージャ側でヘルプ ビューアへの参照をすべて解放できるようにする必要があります。なお、クッキーを渡せないか、間違ったクッキーを渡すと、ヘルプ マネージャは間違ったヘルプ ビューアへの参照を解放するおそれがあります。
  • ShutDown -- ヘルプ マネージャから呼び出され、ヘルプ ビューアに次のことを通知します。つまり、ヘルプ マネージャが停止しようとしていることと、ヘルプ ビューアで割り当てたリソースがあれば、それを解放しなければならないことです。リソースの解放は、すべて、このメソッドに委譲することをお勧めします。
  • SoftShutDown -- ヘルプ マネージャから呼び出され、ヘルプ ビューアを読み込み解除せずに外部へのヘルプ システムの表示(ヘルプ情報を表示しているウィンドウなど)をすべて閉じるようにヘルプ ビューアに要求します。

関連項目