アプリケーションからの HTML ヘルプの呼び出し

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

アプリケーションでヘルプを使用可能にする への移動

メモ: このセクションで説明されているヘルプ機能のほぼすべてが、Delphi アプリケーションと C++ アプリケーションの両方で、ほとんど同じ方法で使用することができます。たとえば、Delphi では、Vcl.HtmlHelpViewer ユニットをアプリケーションの uses 句に追加する必要があり、C++ では、#include Vcl.HtmlHelpViewer.hpp 指令を追加する必要があります。

RAD Studio の IDE では、[<プロジェクト> のプロジェクト オプション]および[オブジェクト インスペクタ]で、どのヘルプ ファイルのどのヘルプ トピックを表示するかを定義するためのオプションが用意されています。 RTL および VCL ライブラリで提供されているヘルプ処理クラスとこのオプションを組み合わせることで、以下の機能を使用でき、手動でプログラムを書かなくても作成した RAD Studio アプリケーションでヘルプを表示することができます。

  1. F1 を押してヘルプを表示
F1 キーを押すというのはアプリケーションでヘルプを表示するための標準的な方法です。 RAD Studio の IDE では、RTL および VCL ライブラリを使って、F1 を押したときにヘルプを表示するためのコードを自動生成します。 [オブジェクト インスペクタ]などの IDE 機能を使って、F1 を押したときに表示するヘルプ ファイルおよびヘルプ トピックを定義するオプションを設定できます。
トピック「VCL アプリケーションにおける F1 ヘルプのデフォルトの処理」および「VCL アプリケーションにおける F1 ヘルプのカスタマイズ」で、ヘルプ処理関数を呼び出す際のパラメータの定義方法について説明しています。
  1. ボタンを押してヘルプを表示
[ヘルプ]ボタン(Vcl.Buttons.TBitBtn 型で種類が Kind = bkHelp であるボタン)を使用して、ヘルプ トピックそ表示することができます。
  1. メニュー コマンドをクリックしてヘルプを表示
RAD Studio は、4 つの標準ヘルプ処理アクション(Vcl.StdActns.THelpContentsVcl.StdActns.THelpOnHelpVcl.StdActns.THelpTopicSearchVcl.StdActns.THelpContextAction)を提供しており、これらをメニュー項目やツールバー ボタンに割り当てることができます。
  1. 選択されたメニュー コマンドについてのヘルプの表示
メニュー項目を強調表示して F1 を押すと、関連するヘルプ トピックを表示できます。
  1. 指している画面オブジェクトについてのヒントを表示
Hint プロパティを使用すると、フォームやコントロールなどの画面オブジェクトについて状況依存のヒントを表示することができます。 このようなヒントは、"What is this?"(これ何?)ヘルプとも呼ばれます。

関連項目