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

hiGetFieldInfo

hiGetFieldInfo( 
r_2DFormOr2DMenu 
s_field 
) 
=> l_dimensions / nil

Description

Returns the dimensions of any form field or 2D menu item that is in an instantiated form. Do not use the return value of hiGetFieldInfo to restore a field to its original location. Instead, use the values you specified originally.

hiGetFieldInfo does not work for uninstantiated forms. You can instantiate a form with hiInstantiateForm and then use hiGetFieldInfo.

Arguments

r_2DFormOr2DMenu

Form or menu returned from hiCreateAppForm, hiCreateForm, or hiCreate2DMenu.

s_field

SKILL symbol representing the field in r_form to be queried. This symbol is the field handle (?name) argument when the field was created.

Value Returned

l_dimensions

A list containing the x and y coordinates, width, height, and the prompt box width or title height (if any) of the field.

Note: Do not use the return value of hiGetFieldInfo to restore a field to its original location. Instead, use the values you specified originally.

nil

The list is not returned. An error message is displayed.

Examples

list ( ( x y ) ( width height ) pBoxWidth )

Related Topics

hiCreateAppForm

Two Dimensional Form Layout

Form and Field Functions


Return to top
 ⠀
X