hiGetLayoutItemIndex

hiGetLayoutItemIndex(
g_formOrRegion 
s_layoutOrField 
)
=> l_layoutIndex / nil

Description

Returns a list containing the symbol name of the layout, which contains s_layoutOrField, and the index of that item within the layout.

Arguments

g_formOrRegion	A form, scroll region, or a tab page.
s_layoutOrField	A symbol name of a hiLayout, field in the form, or region.

Value Returned

l_layoutIndex	A list containing the symbol name of the layout that contains s_layoutOrField and the index of that item within the layout. Returned as the first argument.
nil	hiLayout is not found.

Examples

If MyForm contains MyLayout, which contains fields MyField1, MyField2, and MyField3 in that order followed by MyLayout1. Then, MyLayout1 returns list('MyLayout 3), and MyField2 returns list('MyLayout 1).

hiGetLayoutItemIndex( MyForm 'MyLayout1 )

=> list('MyLayout 3)

hiGetLayoutItemIndex( MyForm 'MyField2 )

=> list('MyLayout 1)

Related Topics

Form and Field Functions

Return to top