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

hiAddField

hiAddField( 
g_formRegionOrLayout
g_field 
[ x_attachment | s_layout [ l_field_controls ] ] 
)
=> t / nil

Description

Adds a field to a form. The form must already exist, and the field must have been created with one of the field creation routines.

Arguments

g_formRegionOrLayout

  

Any of the following:

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

g_field

The field defstruct, user type, hiLayout defstruct, or list of fields, such as x:y location, width:height, and prompt width when being added to a 2D form.

x_attachment

The attachment flags if the field is being added to an attachment form or region.

s_layout

The symbol of the layout, field, or hiLayout is being added to instead of the main layout of the form or region.

l_field_controls

The hiLayout field controls specified for the field or hiLayout are added to the field only if these controls are added to the hiLayout form.

Values Returned

t

The field is added.

nil

The field is not added. An error message is displayed.

Related Topics

hiLayout Form Functions


Return to top
 ⠀
X