hiSetCurrentField

hiSetCurrentField(
g_form 
s_fieldName
[ g_limitSearch ]
)
=> t / nil

Description

Makes the specified type-in field the current field (sets input focus to the field). If the field is not visible, hiSetCurrentField scrolls the form or scroll region field so the field becomes visible.

The fields that accept focus are determined by the ?fieldFocus argument of the hiCreateAppForm function.

The function first searches for the field at the top level of the form or scroll region field specified. If the field is not found at the top level, all scroll region fields within the form or scroll region field are searched hierarchically. The first field that matches s_fieldName is set as the current field. You can limit the search to only the top level of the form or scroll region field by specifying a non-nil value for the third argument, limitSearch.

This function can only be used when the form is visible on the screen.

Arguments

g_form	The form or scroll region field in which you want to set the current field.
s_fieldName	Field to be made current. If the field is not an editable text field, it is scrolled into view but not given focus. If the field is not found at the top-level of the form or scroll region field, all scroll region fields within the form or scroll region field are searched hierarchically. The first match is selected.
g_limitSearch	Any non-nil value. Use this argument if you want to limit the search for the field to only the top level of the form or scroll region field specified. If this argument is not used, the function first searches the top level of the form or scroll region field and then, if the field is not found, does a hierarchical search of all scroll region fields within the form or scroll region field.

Values Returned

t	The field was made current and input focus was set to the field.
nil	Input focus could not be set to the field.

Related Topics

Form and Field Functions

hiCreateAppForm

Return to top