hiGetStackedLayoutCurrentIndex

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

Description

Returns the index of the current top item.

Arguments

g_formRegionOrLayout

Any of the following:

hiLayout form
Scroll region or tab page in hiLayout form
hiLayout

s_layoutName

The hiLayoutSymbol for a hiLayout contained within the form or region. This argument is ignored if g_formRegionOrLayout is a hiLayout.

If g_formRegionOrLayout is a form or region and s_layoutName is not specified, the main hiLayout of the form or region is used.

Values Returned

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

Examples

The function returns 2. A form, MyForm, within the main layout, MyMainLayout, is a stacked layout that has 5 items where the current top item is index 2.

hiGetStackedLayoutCurrentIndex( MyForm 'MyMainLayout )

=> 2

Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023