hiSetStackedLayoutCurrentIndex

hiSetStackedLayoutCurrentIndex( 
x_index 
g_formRegionOrLayout 
[ s_layoutName ] 
) 
=> x_index / nil

Description

Sets the index of the current top item of a valid stacked hiLayout.

Arguments

x_index	The integer index of the item in the stacked layout that needs to be brought to the top.
g_formRegionOrLayout
	A hiLayout form, a scroll region, or a tab page in the hiLayout form or hiLayout.
s_layoutName	The hiLayoutSymbol for hiLayout contained within the form or region. This argument is ignored if g_formRegionOrLayout is hiLayout.

Value Returned

x_index	The index of the current top item, if the arguments resolve to a valid stacked hiLayout.
nil	The arguments do not resolve to a valid stacked hiLayout.

Examples

Returns the new index of 4. The form, MyForm, with a main layout, MyMainLayout, is a stacked layout that has five items. The previous top item is index 0. Now, to change the top item to the last item, the index value is changed to 4.

hiSetStackedLayoutCurrentIndex( 4 MyForm 'MyMainLayout )

Return to top