hiMoveToFormField

hiMoveToFormField( 
g_formOrRegion
s_field
) 
=> moved / focused / nil 

Description

Sets the input focus to the form, scrolls the form to bring the given field into the view, and warps the pointer to the field.

This SKILL function works only if the specified form is currently displayed, and the given field exists on the form or region, such as a scroll region, a tab field, or a tab page.

If the specified field is a text field and can accept input focus, it is set as the current field and the input focus is set to it.

Arguments

g_formOrRegion	The form or a region on the form.
s_field	The symbol name of the field.

Values Returned

moved	The input focus is set successfully to the form or region, but not to the field because it is not a text field.
focused	The input focus is set successfully to the specified field on the given form or region.
nil	The input focus could not be set to the specified form or region, and the pointer was not warped because the given field does not exist (or is invisible).

Examples

Assuming that the User Preferences form is displayed, the following command moves the pointer to the Web Browser field and set the input focus to it:

hiMoveToFormField( hiSysProps 'hiWebBrowser )

Related Topics

Form and Field Functions

Return to top