create_text_form()

Creates a form whose set of possible values are a set of strings. These can be either a simple list of strings or a list of strings dynamically determined when an item referencing the form is placed. Returns: none.

See also: Format Strings

Syntax:

create_text_form(name, label[, dialogDataStr], attrib, netlistFormat, displayFormat[, optionFunction, validateFunction, dataValue, dataFunction]);

where

name is the unique name of the form.

label is a string describing this form.

dialogDataStr is optional; any dialog data. For the standard edit component dialog box, this argument indicates the gui component to use for the breakdown of the parameter value input. For example, the standard Edit Component dialog supports these gui configurations:

• "StdForm"
• "StringAndReference"
• "SingleTextLine"
• "InstSelectionForm"
• "Node SetForm"

This argument can be omitted if dialogDataStr is the same as formName. For the standard component dialog, this field may be used as the name of the table entry field. For a complete listing, see $HPEESOF_DIR/de/ael/pde_gemini.ael.

attrib is an integer, and should be set to 0.

netlistFormat is a string describing the netlisting of this form's value. Refer to Format Strings.

displayFormat is a string describing the display in the schematic of the values of this form.

optionFunction is optional; a function used to dynamically collect strings.

validateFunction is optional; a function to validate the strings collected by the option function.

dataValue is optional; a string; passed to the optionFunction, validateFunction, and dataFunction.

dataFunction is optional; a function to provide special control over netlist generation.

Example:

create_text_form("SingleTextLineInteger", "IntegerValue", "SingleTextLine", 0, "%v","%v", NULL, stdforms_validate_integer, NULL);

Where Used:

Schematic