helpKey

helpKey プロパティーは、テキスト書式内のフィールドのヘルプ情報を表示するためにユーザーが押すファンクション・キーを指定します。

helpKey プロパティーは、書式、FormGroup、または use ステートメントに指定できます。 use ステートメント上の helpKey 値は、FormGroup 上の helpKey 値をオーバーライドします。 EGL は、書式に helpKey プロパティーが明示的に指定されていない場合にのみ、FormGroup または use ステートメント上の helpKey プロパティーを使用します。 書式に helpKey プロパティーが指定されている場合は、常にその値が使用されます。

EGL は、現行のテキスト書式と関連付けられたヘルプ書式にあるヘルプ情報を検索します。

helpKey プロパティーの値は、PFKeyKind 列挙型の値です。 その列挙型のメンバーは、文字「pf」とそれに続く 1 から 24 までの文字から構成されています。 デフォルトは pf1 です。

PC のキーボードの場合、EGL は、次の表に示すようにファンクション・キーをマップします。 正符号 (+) は、ユーザーが 2 つのキーを同時に押すことを示しています。

表 1. EGL のファンクション・キー・マッピング
3270 キー EGL のキー・マッピング Windows プラットフォームで実行されるプログラムのための追加の EGL キー・マッピング
PF1-PF12 F1–F12  
PF13-PF24 Ctrl+S を押してから F1–F12 を押す Shift+F1-F12
PA1-PA3 Ctrl+A を押してから F1–F3 を押す Ctl+F1-F3
Ctrl+S と Ctrl+A のキーの組み合わせは、以下のように機能します。
  • ユーザーがキー・ストロークの組み合わせ (例えば Ctrl+S) を奇数回押して から下位範囲のファンクション・キー (例えば、F1 から F12) を押した場合、 この 2 番目のキー・ストロークは上位範囲 (例えば、PF13 から PF24) のファンクション・キーであると解釈されます。
  • ユーザーがキー・ストロークの組み合わせ (例えば Ctrl+S) を偶数回押して から下位範囲のファンクション・キー (例えば、F1 から F12) を押した場合、 この 2 番目のキー・ストロークは下位範囲のファンクション・キーであると解釈されます。
  • ユーザーがキー・ストロークの組み合わせを 1 回押してから関連付けられているファンクション・キー以外のキーを押した場合、そのキー・ストロークの組み合わせは効果を持ちません。 ただし、入力フィールドにフォーカスがあり、2 番目のキー・ストローク (例えば「a」) に表示可能文字が関連付けられている場合は、その文字がフォームに表示されます。

以下のコードは、ヘルプ・キーをデフォルトの F1 から F4 に変更します。
helpKey = PFKeyKind.pf4

互換性

表 2. helpKey プロパティーのサポート
データ項目 JSF ハンドラー VGUI レコード コンソール UI テキスト書式 Java™ テキスト書式 COBOL 印刷書式 Java 印刷書式 COBOL
あり なし なし なし あり あり* なし なし

* 互換性に関する考慮事項を参照してください。

表 3. helpKey の互換性に関する考慮事項
プラットフォーム 問題
IMS/VS ご使用のインストール済み環境で IMS™ の ローカル・コピー機能用に PF12 が使用されている場合は、ヘルプ・キーに PF12 を使用しないでください。