hiGetLayoutFrame

hiGetLayoutFrame(
g_formRegionOrLayout 
[ s_layoutName ]
)
=> t_title / t / nil

Description

Returns the frame title of a hiLayout form, a scroll region, or a tab page in the hiLayout form.

Arguments

g_formRegionOrLayout
	Any of the following values: hiLayout form Scroll region or tab page in hiLayout form hiLayout
s_layoutName	A hiLayoutSymbol for a hiLayout contained within the form or region. If this argument is not specified, then the main hiLayout of the form or region is used.

Value Returned

t_title	The frame title.
t	True, if the frame has no title.
nil	Nil, if the layout is not a frame layout.

Examples

Returns nil because the layout is not a main layout.

hiGetLayoutFrame( MyForm )

=> nil

Returns nil because the layout is not a frame layout.

hiGetLayoutFrame( MyForm 'MyMainLayout )

=> nil

Returns the frame title, Frame.

hiGetLayoutFrame( MyForm 'MyTitleLayout )

=> "Frame"

Returns t because the frame, 'MyFrameLayout, has no title.

hiGetLayoutFrame( MyForm 'MyFrameLayout )

=>t

Related Topics

Form and Field Functions

Return to top