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

hiSetCurrentForm

hiSetCurrentForm(
g_form
[ g_setIfNotDisplayed [ g_setIfNotInstantiated ] ]
)
=> t / nil

Description

Makes the form you specify the current form. If the form is displayed, moves the focus to the form.

Arguments

g_form

Form handle returned by hiCreateAppForm or the symbol that was set by the ?name argument of hiCreateAppForm when the form was created.

g_setIfNotDisplayed

  

Displays the current form if it is instantiated or if not instantiated and g_setIfNotInstantiated is set to t.

If the form is not displayed and g_setIfNotDisplayed is nil or not specified, then a warning is displayed and the function returns nil without changing the current form.

g_setIfNotInstantiated

  

Displays the current form even if it is not instantiated.

Value Returned

t

The specified form is the current form.

nil

The specified form is not instantiated and either g_setIfNotDisplayed or g_setIfNotInstantiated is nil. Invalid ID or the form is not displayed and g_setIfNotDisplayed is nil.

Related Topics

Form and Field Functions

hiCreateAppForm


Return to top
 ⠀
X