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

hiCreateFrameField

hiCreateFrameField(
?name s_fieldName 
[ ?labelText t_labelText ] 
[ ?enabled g_enabled ]
[ ?invisible g_invisible ]
)
=> r_fieldHandle

Description

Creates a frame field for a two-dimensional form. A frame field is a border that surrounds a group of related fields so they are easier to see.

If t_labelText is specified and you specify 2D attributes for the frame field, you must also specify the label height in the 2D attributes even though the value is ignored. For example:

list( r_framefield x_xpos:x_ypos x_width:x_height x_labelHeight)

The frame field created by hiCreateFrameField is not supported by the hiLayout form. The frame field gets replaced by a frame property on the layout container.In this case, the frames have the advantage to automatically fit to the layout container, even when fields are added or deleted from a container.

Arguments

?name s_fieldName

Handle to the frame field.

?labelText t_labelText

  

Title of the frame field. If the title is specified it appears in the upper left corner of the frame. The title must not extend beyond the width of the frame.

?enabled g_enabled

  

Specifies whether the fields in the layout are enabled. The default value is t.

?invisible g_invisible

  

Specifies whether the layout and the fields within are invisible. The default value is nil.

Values Returned

r_fieldHandle

Field handle for the frame field.

Examples

f = hiCreateFrameField( ?name 'f ?labelText "New Frame Field" )
g = hiCreateAppForm( ?name 'g ?fields list ( list ( f 10:20 200:200 14 ) ) )
hiDisplayForm ( g )

Related Topics

Form and Field Functions


Return to top
 ⠀
X