Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


HTML
<!-- REMEMBER! A template can not currently be reapplied. If you want to start over, you'll need to create a new page. Not everything in this template will be used for every API page, it's meant to be a quick format setup. Content can be added and removed as needed after filling out what you want of the form and clicking 'Next', which takes you to the editor. Be aware of where you are putting the page! If you put it in the wrong place, you can go to http://www.profoundlogic.com/docs/pages/listpages-dirview.action?key=PUI and drag'n'drop it at the proper place in the tree. Some of the columns have odd widths, widths are just suggestions in confluence for some reason. If two columns have the same width, they will take up equal-ish space. Any questions on how to use a template, feel free to ask Megan. All HTML notes can be deleted or changed as needed. Everything can be copied and pasted as needed. EXAMPLE OF FINISHED PAGE: pjs.query() -->
Column
width60%

API Overview

The pui.getAllScreenProps() API retrieves Retrieves all of the screen-level properties of a record format.

Note

Available in Version 5, Fix Pack 14.0 or later.




Section


Column
width25%

Parameters

  • Record Format Name (optional)

   

 

Column
width25%

Return Value

  1. If record format name is passed:
    1. An object that contains all of the screen-level properties
    2. False, if record format name could not be found

  2. An array of objects each representing each record format currently displayed
  3. False, if no record format is found


Column
width50%



Examples

Code Block
languagejavascriptjs
titleTitle of Example CodeRetrieve Array of Displayed Record Formats
 var recs = pui.getAllScreenProps();         // returns an array of record formats that are currently dispalyeddisplayed.
 var userData = rec[0]['user defined data']; // returns the value of the user defined data property for the first record in the recs array.
 
 


Code Block
languagejs
titleRetrieve Object of Record Format Properties
 var myRec = pui.getAllScreenProps('CTL');   // returns an object containing all the defined screen properties for the 'CTL' record format.
 var userData = myRec['user defined data'];  // returns the value of the user defined data property.

...