hiOffsetField

hiOffsetField( 
r_2DFormOr2DMenu 
s_field 
l_offsets 
) 
=> t / nil 

Description

Offsets one field from its current position. 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 has no effect. Negative offsets may be specified, but the minimum value of the new x and y is 0. Both offset values are required.

Use this function to offset a single field. To offset more than one field, use hiOffsetFields.

The form must be instantiated.

Arguments

r_2DFormOr2DMenu	Two-dimensional form or menu returned from hiCreateAppForm, hiCreateForm, or hiCreate2DMenu.
s_field	SKILL symbol representing the field 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 field is offset.
nil	The field is not offset. An error message is also issued.

Examples

Offsets the ‘myField field by 10:20 pixels from the current location.

hiOffsetField ( testform ‘myField 10:20 )

=> t

Related Topics

Form and Field Functions

hiCreateAppForm

hiCreateForm

Return to top