2.25.1 ヘルプ・テキストの記述

フィールド、フォーム、または再利用可能パーツのヘルプ・テキストを記述できます。フォームと再利用可能パーツの場合は、フォームまたはパーツの特定のコントロールの各ヘルプ・トピックをヘルプに挿入できます。

ヘルプ・テキストは、アプリケーションの実行中にユーザーがF1を押したり、フォームのタイトル・バーのヘルプボタンをクリックすると表示されます。

ヘルプ・テキストを記述するには、フィールド/コンポーネントのリストを表示し、リポジトリ ヘルプタブで以下のようにします。

ヘルプ・テキストを入力し、アプリケーションをコンパイルして実行します。ユーザーがF1を押すと、このようにヘルプが表示されます。

フォームと再利用可能パーツの場合は、フォームまたはパーツの特定のコントロールの各ヘルプ・テキストを追加できます。このためには、現在作業している言語のヘルプ・テキストの最後の行に移動します。$$COMPONENT=で始まる行を追加し、ヘルプを追加するコントロールの名前を続けます。例:

$$COMPONENT=PHBN_1

 

この行のすべてのテキストを大文字で入力し、$$LANGUAGEタグの前に置く必要があります。次の行にヘルプ・テキストを開始します。

状況により、ヘルプの本体にすべてのコントロールのすべてのヘルプを追加し、すべてのトピックが同じ場所に表示されるようにするほうがわかりやすい場合もあります。これ以外の場合で特にヘルプ・テキストが長い場合は、ヘルプを適切なコントロールに割り当てることをお勧めします。

以下のキーワードを入力することにより、ヘルプ・テキストにイメージを追加できます。

$$IMAGE=STOPLIGHT.BMP

 

コンポーネントのヘルプ・テキストにイメージを追加する場合は、$$COMPONENTキーワードの前に置く必要があります。

ヘルプの検索順

このヘルプは、各コントロール、フィールド、再利用可能パーツの特定のヘルプを最初に検索します。これが存在しない場合は、フォームまたは再利用可能パーツのヘルプが検索されます。

グループ・ボックス、タブ・シート、パネルなどの他のコントロールを格納できるコントロールの場合は、コンテナ・コントロールのヘルプ・テキストを記述することをお勧めします。

これにより、グループ・ボックスなどに定義されたヘルプですべてのラジオ・ボタンがその中で動作する方法を説明できます。ヘルプがラジオ・ボタンのいずれかで要求されると、グループ・ボックスのヘルプが代わりに表示されます。