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

hiDeleteField

hiDeleteField( 
g_formRegionOrLayout 
s_fieldOrLayout 
) 
=> t / nil

Description

Deletes a field from a form.

To delete more than one field from the same form, use hiDeleteFields. This is especially true if a contiguous set of one-dimensional form fields are deleted.

Deleting a field from a 2D form removes the instance of the field from the form, and assumes that there is only one instance of this field contained within the form. The field still exists in any other form which contains it.

In a two-dimensional form or menu, no geometry management is performed to fill the freed area of the screen. If the field is deleted from a one-dimensional form, the field is removed and the other fields adjusted appropriately.

Arguments

g_formRegionOrLayout

  

Specifies a form, scroll region, tab page, or hiLayout from which the field is deleted.

s_fieldOrLayout

The symbol name of the field or hiLayout to be deleted. This does not delete the field or layout defstruct or other instantiations of the field or layout.

Values Returned

t

The field is deleted.

nil

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

Related Topics

hiLayout Form Functions

hiDeleteFields


Return to top
 ⠀
X