hiCreateSeparatorField

hiCreateSeparatorField(
?name s_fieldName
[ ?invisible g_invisible ]
)
=> r_fieldHandle

Description

Creates a separator field for a form.

A separator is a line used to separate fields for easier visual recognition. It is always two pixels thick. Only horizontal separators can be created for one-dimensional forms. Two-dimensional forms can have vertical or horizontal separators. A horizontal separator in a 1D form always spans the width of the form.

When specifying 2D attributes for a separator field use the following format:

list( r_separatorField x_xpos:x_ypos x_length:x_orient)

x_xpos:x_ypos represents the origin of the separator. The length can be controlled by x_length but the thickness is always two pixels. x_orient is 0 if the separator is horizontal, 1 if vertical.

Arguments

?name s_fieldName	Handle to this field within a form.
?invisible g_invisible
	t or nil. Specify t if you want the field to be invisible; specify nil if you want the field to be visible. The default value is nil. You can modify the value of this argument (after the form is created) with the invisible property. For example: formHandle->fieldSym->invisible = nil

Value Returned

r_fieldHandle

Handle for the separator field.

Examples

An example of specifying a horizontal separator 40 pixels long starting at 10:30 is:

list( hiCreateSeparatorField progld ( ?name ’sep ) 10:30 40:0 )

Related Topics

Form and Field Functions

Return to top