hiOffsetFields

hiOffsetFields( 
r_2DFormOr2DMenu 
l_fields
l_offsets 
) 
=> t / nil 

Description

Offsets several fields from their current positions. All fields are offset by the same distance, they move as a block. This function cannot be used for fields that have field attachments. Use hiReattachField for fields with field attachments.

This routine adds the x and y offset values and the current x and y values to determine the new field position. An offset of 0 have no effect. Negative offsets can be specified, but the minimum value of the new x and y is 0. Both offset values are required.

The form must be instantiated.

To offset only one field, use hiOffsetField.

Arguments

r_2DFormOr2DMenu	Two-dimensional form or menu returned from hiCreateAppForm, hiCreateForm, or hiCreate2DMenu.
l_fields	List representing the fields in r_form you wish to offset.
l_offsets	Distance in pixels the field is set off from the current position. offsets is of the form: list( x_xOffset x_yOffset ) or x_xOffset : x_yOffset

Value Returned

t	The fields are offset.
nil	The fields are not offset. An error message is also issued.

Examples

Offsets the fields ‘(myField myField2 ) by -10:0 pixels from the current location

hiOffsetFields ( testform ‘(myField myField2 ) -10:0 )

=> t

Related Topics

Form and Field Functions

hiCreateAppForm

hiCreateForm

Return to top