hiGetLayoutType
hiGetLayoutType(
g_formRegionOrLayout
[ s_layoutName ]
)
=> s_type / nil
Description
Returns the type of hiLayout. The layout types that can be returned are 'hbox, 'vbox, 'grid, 'form, or 'stacked.
Arguments
|
g_formRegionOrLayout
|
|
|
Any of the following:
-
hiLayout form
-
Scroll region or tab page in hiLayout form
-
hiLayout
|
|
s_layoutName
|
The hiLayoutSymbol for an 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.
|
Value Returned
|
s_type
|
Returns the type of the hiLayout.
|
|
nil
|
hiLayout is not valid.
|
Examples
A form, MyForm, with the main layout, MyMainLayout, has a vertical box layout 'vbox, which is returned.
hiGetLayoutType( MyForm )
=> 'vbox
Related Topics
Form and Field Functions
Return to top
