Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiSetLayoutFrameTitle

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

Description

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

Arguments

g_title

Set the title for a frame layout.

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 with 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

Set and returns the title, Frame for the frame layout, 'MyFrameLayout.

hiSetLayoutFrameTitle( "Frame" MyForm 'MyFrameLayout )
=> Frame

Related Topics

Form and Field Functions


Return to top
 ⠀
X