Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGetLayoutFields

hiGetLayoutFields( 
g_formRegionOrLayout 
[ s_layoutName ]
) 
=> x_fields / nil

Description

Returns the list of symbolic names of field items in hiLayout.

Arguments

g_formRegionOrLayout

  

Any of the following:

  • hiLayout form
  • Scroll region or tab page in hiLayout form
  • hiLayout

If it is a form or region and s_layoutName is not specified, the main hiLayout of the form or region is used.

s_layoutName

A symbol name of a hiLayout, field in the form, or region.

Values Returned

l_fields

The list of symbolic names of the field items in the hiLayout

nil

Nil, if the symbolic names of the field items does not exist.

Examples

Returns the symbolic names of field items, MyField1, MyField2, and MyField3 from the layout, MySubLayout.

hiGetLayoutFields( MyForm ) ;; returns fields contained in MyMainLayout
=> nil
hiGetLayoutFields( MyForm 'MySubLayout )
=> MyField1 MyField2 MyField3

Related Topics

Form and Field Functions


Return to top
 ⠀
X