Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

vfoGRNewCreateForm

vfoGRNewCreateForm(
t_uniqueFormIdentifier
t_formType
[ l_callbackList ]
) 
=> r_formPointer / nil

Description

Creates the new Create Guard Ring form, that is, a new form pointer along with the unique fields and form symbol.

Arguments

t_uniqueFormIdentifier

An alphanumeric unique identifier string that will be used for creating the Create Guard Ring form, which can be retrieved using vfoGRGetCreateFormIdentifier.

t_formType

One of the following two values, 'OKCancelApply and 'HideCancelDef, which define the layout of the form.

l_callbackList

List of the callback procedures required for controlling the display of the OK, Cancel, and Apply buttons on the form. This is an optional argument.

If this argument is not provided and you chose the 'HideCancelDef type of form, then you can create an FGR using either of the following modes: Wrap, Path, Rect, and Polygon.

However, if you did not set this argument and choose the 'OKCancelApply type of form, then the default callback is provided only for the Wrap mode.

Value Returned

r_formPointer

The form pointer associated with the Create Guard Ring form.

nil

The form could not be created.

Example

form_pointer = vfoGRNewCreateForm("MODGEN" 'OKCancelApply)
        hiDisplayForm(form_pointer)

Return to top
 ⠀
X