hiSetKeyboardFocusField

hiSetKeyboardFocusField( 
g_formOrRegion 
s_field 
[ g_limitSearch [ g_onlyCurrentTabPage ]]
) 
=> t / nil

Description

Sets the keyboard focus to field, s_field, if it is found in the form or region, g_formOrRegion and is allowed to have keyboard focus. It also enables you to do a hierarchical search if g_limitSearch is not specified or is set to nil. The search is limited to only the top-level of the form or scroll region field if, g_limitSearch is specified as a non-nil value.

Arguments

g_formOrRegion	The form, scroll region field, or tab field page in which you want to set the current field.
s_field	The field on which the keyboard focus needs to be set.
g_limitSearch	The level of the form or specified region up to which the search is limited.
g_onlyCurrentTabPage
	The currently visible tab page of the tab field up to which the search is limited.

Values Returned

t	True, if the input focus is set to the field.
nil	Nil, if the input focus could not be set to the field.

Examples

Sets keyboard input focus on the Place Manually Boolean button field in the User Preferences dialog.

hiSetKeyboardFocusField( hiSysProps 'ciwHistoryLines )

Related Topics

Form and Field Functions

Return to top