pui.buildFKeyMenu( config )

Owned by Alex Roytman
Last updated: Aug 16, 2023 by Jessica Tomkins
1 min read



This API populates a menu widget with function keys located on a converted record format.  The call to this API is typically placed on the screen's onload event.

Parameters:

  • optional config object - JavaScript object containing configuration properties

Configuration Options:

  • prefix - id prefix to identify function key elements; possible values are "link" for hyperlinks or "btn" for buttons; if omitted, "btn" is assummed

  • fkeyMenuId - the id of the Menu element to populate; if omitted, the default id of "fkeyMenu" is used

  • availableKeys - an id or an array of id's that point to output or hidden elements that identify which keys are available; the elements should have content such as "F3=Exit  F5=Refresh  F12=Cancel"; if this configuration option is specified, function keys that are not available will not appear on the menu

  • skipF24 - boolean value specifying whether F24 (More Keys) should be omitted when building the menu; if this configuration option is not specified, true is assummed

  • skipHelp - boolean value specifying whether the Help Key should be omitted when building the menu; if this configuration option is not specified, false is assummed