?name s_fieldName

Handle to this field within a form. To reference it, use:

formHandle->hiFieldSym

prompt t_fieldPrompt

Optional prompt for this field. To reference it, use:

formHandle->hiFieldSym->prompt

?value l_currentValue

Initial and current value of this field in the correct format. This is a required parameter. May be nil, in which case the bBox field appears blank. To reference the current value, use:

formHandle->hiFieldSym->value

?help g_fieldHelp

A string or symbol used to reference help. If not specified, s_fieldName is used. This argument is currently not used.

?defValue l_defaultValue

Default value of the field (in the correct format). This value is equal to the initial entry in l_currentValue if l_defaultValue is not specified. To reference the default value, use:

formHandle->fieldSym->defValue

formHandle->hiFieldSym->defValue

?font t_font

An optional font argument is accepted but not supported at this time.

?callback g_callback

Callback for this field. The callback can be string, symbol, or a function object type. The callback is called when the field has lost focus (when the cursor leaves the form, the user tabs to another field, and so forth) or when the user selects any button in the form.

If the callback is of string type, you can specify one or more SKILL functions or even multiple SKILL statements that should be executed when the value of the field changes.

?modifyCallback g_modifyCallback

Do not use the g_modifyCallback argument with this field because it may not work as expected. Use this argument only with string fields.

SKILL function to be executed whenever any change is made in the text field, for example, by typing or pasting. The modify callback is called when a change is detected in the field but before the change is displayed.

The modify callback function is passed the following arguments:

s_fieldName t_latestTextValue g_sourceOfChange

where s_fieldName is the symbol of the field in which the change was made, t_latestTextValue is the latest text value of the field, and g_sourceOfChange is t or nil where t indicates that the change was made programmatically (by changing the value of the field) and nil indicates that the change was made by a user action.

The modify callback function should return the following:

t | nil | value

If the modify callback function returns t, the changes made to the field are allowed and are displayed as they are entered. If the function returns nil, the changes made to the field are not allowed and are not displayed—the original value of the field is retained. If the function returns some other value, it must be a bounding box. This value replaces the current value of the field.

?focusInCallback g_focusInCallback

SKILL function to be executed whenever the field comes into focus. You provide this function.

?editable g_editable

Enables the editing of the field.

?enabled g_enabled

Specifies whether the fields in the layout are enabled. The default value is t.

?invisible g_invisible

Specifies whether the layout and the fields within are invisible. 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

?nextField g_nextField

Symbol or string indicating the next field to bring into focus when the Tab key is pressed. If you specify nil or do not specify this argument, the Tab traversal order is determined by the tabOrderIsAddOrder argument of hiCreateAppForm or hiCreateScrollRegion. If the tabOrderIsAddOrder argument is not set or if its value is nil, the default traversal order is based on the form layout —left-to-right and top-to-bottom— beginning with the field at the top-left corner of the form.

r_fieldHandle

Handle to the bounding box field.