pui.getScreenProp()

API Overview

The pui.getScreenProp() API retrieves the property value of a defined screen-level property.

Available in Version 5, Fix Pack 14.0 or later.

Parameters

  • Record Format Name
  • Property Name

Please Note:

If no Record Format Name is passed, it will use the last record format name from the currentFormatNames() API.



Return Value

  1. Property value, if the property is found.
  2. False, if the property is not found.



Examples

Title of Example Code
 var userData = pui.getScreenProp('CTL', 'user defined data') // returns the value of the user defined data property for that screen.
 
 var userData = pui.getScreenProp('user defined data') // returns the value of user defined data property for the last record format retrieved from currentFormatNames() API