hiDeleteFields

hiDeleteFields( 
g_formRegionOrLayout 
l_fieldsOrLayouts 
) 
=> t / nil

Description

Deletes multiple fields from a form.

To delete more than one field from the same form, this function should be used instead of multiple calls to hiDeleteField.

For one-dimensional forms, hiDeleteFields optimizes the deleting of a contiguous list of fields (given in top-to-bottom order) by moving each remaining field once, after all fields have been 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 a 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.
l_fieldsOrLayouts	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

Return to top