hiSetListItemCenter

hiSetListItemCenter(
o_listBoxField
x_position
)
=> t / nil

Description

Brings the specified list box item into view in the center of the list box, if possible. Takes a list box field of a form as the first argument and the numeric position of the item you want to bring into view as the second argument.

If the numeric position specified is 0 or less than 0, the last item in the list is scrolled into view.

If you specify the first or last item in the list, white space is never created above or below the item to bring it into the center of the list box.

Arguments

o_listBoxField	The list box field.
x_position	Numeric position of the list box item you want to bring into view. The first item is represented by 1. If x_position is 0 or less than 0, the last item in the list is scrolled into view.

Values Returned

t	In all cases except when x_position is greater than the number of items in the list box.
nil	x_position is greater than the number of items in the list box.

Related Topics

Form and Field Functions

Return to top