hiGetGridLayoutItemLocation

hiGetGridLayoutItemLocation( 
g_formOrRegion 
s_layoutOrField 
) 
=> l_gridLayoutLocation | nil

Description

Searches for a list containing the symbol name of the layout that contains s_layoutOrField, and the row, column, row span, and column span of that item within the layout.

Arguments

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

Values Returned

l_gridLayoutLocation
	A list containing the symbol name of the layout containing s_layoutOrField, and the row, column, row span, and column span of that item within the layout.
nil	g_formOrRegion is not instantiated, or either the field or hiLayout is not found in it.

Examples

If MyForm contains a grid layout that was created as follows:

MyNameLayout = hiCreateGridLayout( 'MyNameLayout ?frame "Enter Full Name" ?items list (
    list ( hiCreateLabel( ?name 'MyFirstLabel ?labelText "First" ) 'row 0 'col 0 )
    list ( hiCreateStringField( ?name 'MyFirstName ) 'row 0 'col 1 )
    list ( hiCreateLabel( ?name 'MyMiddleLabel ?labelText "Middle" ) 'row 1 'col 0 )
    list ( hiCreateStringField( ?name 'MyMiddleName ) 'row 1 'col 1 )
    list ( hiCreateLabel( ?name 'MyLastLabel ?labelText "Last" ) 'row 2 'col 0 )
    list ( hiCreateStringField( ?name 'MyLastName ) 'row 2 'col 1 )
    list ( 'col_stretch 1 1 )
) )

MyMiddleLabel is in the grid layout, MyNameLayout, in row 1and column 0, and spans 1 row and 1 column.

hiGetGridLayoutItemLocation( MyForm 'MyMiddleLabel )
=> (MyNameLayout 1 0 1 1)

Related Topics

Form and Field Functions

Return to top