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

hiToggleEnterForm

hiToggleEnterForm(
[ g_form ]
) 
=> t / nil 

Description

Displays or removes the options form of the enterfunction in the current window.

If the options form was not displayed, it is now displayed; if the options form was displayed, it is removed. If the enterfunction does not have an options form, or if no enterfunction is active, a warning dialog box is displayed.

Argument

g_form

Options form to toggle on or off. This allows you to toggle an enterfunction form regardless of whether it is associated with the current window.

Values Returned

t

The display status of the form was changed.

nil

The display status of the form was not changed.

Examples

Creates circleForm that contains options for your circle.

enterCircle( ?prompts list( "Center" "Radius" ) ?form circleForm )

Now type

hiToggleEnterForm( circleForm )

The form pops up, and you can set options. Type it again and the form disappears again.

Related Topics

User Entry Functions


Return to top
 ⠀
X