hiGetLayoutMargins
hiGetLayoutMargins(
g_formRegionOrLayout
[ s_layoutName ]
)
=> l_margin / nil
Description
Returns the top, bottom, left, and right margins of the layout.
Arguments
|
g_formRegionOrLayout
|
|
|
Specifies one 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.
|
Values Returned
|
l_margin
|
A list of four integers and/or nil values that specifies the left, top, right, and bottom margins (in this order). If the form or layout is not yet instantiated, the default values are used and nil is returned. However, if the form or layout is instantiated, the margin values are returned.
|
|
nil
|
Nil, if the hiLayout form does not exist or a valid hiLayout is not specified.
|
Examples
In form, MyForm, with main layout, MyMainLayout, the left and right margins are set to have the default values and the top margin is set to 8 and the bottom margin to 4.
hiGetLayoutMargins( MyForm )
=> (nil 8 nil 4)
Related Topics
Form and Field Functions
Return to top
