formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Lists

# fz_fuim_list_set_auto_scroll

Description

Sets the auto-scroll status of a list.
When auto-scroll is set, at least one picked item in the list is always viewable. If none of the current items in the list are picked, the list will auto-scroll to the first picked item. If there are no picked items in the list, nothing happens.

Plugin Prototype

fzrt_error_td fz_fuim_list_set_auto_scroll(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_boolean | auto_scroll )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

auto_scroll [Input]

auto-scroll. TRUE if auto-scroll is on, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

Function Set

fz_fuim_fset

Defined in

fz_fuim_list_api.h