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

hiIsFormDisplayed

hiIsFormDisplayed( 
r_form 
) 
=> t / nil 

Description

Checks whether a form is displayed.

Argument

r_form

Form being checked for visibility.

Values Returned

t

The form is displayed.

nil

The form is not displayed or is not instantiated.

Examples

;****************************************
;Sample form and fields
;****************************************
; Create string entry for the form. 
procedure( myformDefineFields()
  strfldglb = hiCreateStringField(
    ?name `strfldglb
    ?prompt "sample string field"    ;;; FIELD1, a string type
    ?defValue "initial string"
    ?callback "my_strfldglb_cb()"
    ?editable t
)
  ; Create a Boolean button for the form. 
  boolfldglb = hiCreateBooleanButton(
    ?name `boolfldglb
    ?buttonText "sample boolean field"        ;;; FIELD2, a boolean type
    ?defValue t
    ?callback "my_boolfldglb_cb()"
  )
  list( strfldglb boolfldglb )
)
; Generate the form
procedure( myformcreateform()
  if( !boundp(`myformglb) || (myformglb == nil)
    then
    myformglb = hiCreateAppForm(
      ?name `myformglb
      ?fields myformDefineFields()
      ?formTitle "My first Form"
      ?callback "myformglb_cb()"
      ?buttonLayout `OKCancel
    )
  )
  myformglb
)
; Display the form
procedure( myformdisplayform()
  myformcreateform()    ;;; Creation and Display are separate
  hiDisplayForm(`myformglb)
)
; Check the current state of the form
hiIsFormDisplayed(myformglb) =>nil
myformdisplayform()
hiIsFormDisplayed(myformglb) 
=>t

Related Topics

Form and Field Functions


Return to top
 ⠀
X