g_formRegionOrLayout

Any of the following:

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

g_item

A field, hiLayout, or spacer item to be added to the layout.

The spacer items are:

• 'col_min_width x_column x_width: Specifies the minimum width for a column.
• 'row_min_height x_row x_height: Specifies the minimum height for a row.
• 'col_stretch x_column x_stretch_factor: Specifies the horizontal stretch factor for a column.
• 'row_stretch x_row x_stretch_factor: Specifies the vertical stretch factor for a row.

?layoutControls l_layoutControls

The controls that are appropriate to the layout type to which the items are being added. If these items are being added to a grid layout, then the row and column controls must be specified.

The required layout controls are:

• 'row x_row: Specifies the row in which the field or layout is placed. The topmost row is 0.
• 'col x_column: Specifies the column in which the field or layout is placed. The leftmost column is 0.
• The optional layout control is: 'prompt t | nil | t_prompt:
  • If t is specified then the label portion of the form layout row gets occupied by the field prompt (if any) or an empty string if either the field has no prompt or it is a layout object.
  • If nil is specified then the field prompt is ignored (if any) and the field or layout spans both the label and field column.
  • If t_prompt is specified then the label for the row and any prompt defined for the field is ignored.
  • If no value is specified then the field prompt is used (if any) or a blank prompt is assumed.

?index x_index

The index position in which the item is to be inserted.

?toLayout s_layoutName

The hiLayoutSymbol for an hiLayout contained with the form or region. This argument is ignored if g_formRegionOrLayout is a hiLayout.

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

t

The operation is successfully completed.

nil

The operation is not completed.