helpKey

The helpKey property specifies a function key that the user presses to display help information for a field in a text form.

You can specify the helpKey property on a form, FormGroup, or use statement. The helpKey value on the use statement overrides that on the FormGroup. EGL uses the helpKey property on the FormGroup or use statement only when a form does not explicitly specify the property. If the form specifies the helpKey property, that value is always used.

EGL looks for the help information in a help form associated with the current text form.

The value of helpKey property comes from the PFKeyKind enumeration. The members of that enumeration consist of the characters "pf" followed by a number between 1 and 24, inclusive. The default is pf1.

On a PC keyboard, EGL maps the function keys as follows:

Table 1. EGL function key mapping
Function EGL key mappings in Windows® EGL key mappings on Linux® and AIX®
PF1-PF12 F1-F12 F1–F12
PF13-PF24 Shift+F1-F12 Press Ctrl+S and then press F1–F12
PA1-PA3 Ctl+F1-F3 Press Ctrl+A and then press F1–F3
Notes:

Example

The following code changes the help key from the default of F1 to F4.
helpKey = PFKeyKind.pf4

Compatibility

Table 2. Support for helpKey property
Data item JSF handler VGUI record Console UI Text Form Java™ Text Form COBOL Print Form Java Print Form COBOL
Yes No No No Yes Yes* No No

* See compatibility considerations below.

Table 3. Compatibility considerations for helpKey
Platform Issue
IMS/VS If your installation uses PF12 for the IMS™ local copy function, then do not use PF12 as the help key.

Feedback