ConsoleForm properties

A Record part with the ConsoleForm stereotype has the following properties. formSize is the only required property.
delimiters
Specifies the characters that are displayed before and after input fields. The characters are displayed only if the value of the showBrackets property is YES.
  • Type: String literal
  • Example: delimiters = "<>/"
  • Default: "[]|"

Wherever possible, the first character is displayed before each console field that is not a constant, and the second character is displayed after each console field that is not a constant. The third character is displayed between two non-constant console fields that are separated by a single position.

If you specify fewer than three characters, a default character is in effect for each unspecified character. If you specify more than three characters, the fourth and subsequent characters are ignored.

formSize
The dimensions of the form. The property must contain an array of two positive integers: the number of lines followed by the number of columns.
  • Type: INT[2]
  • Example: formSize = [24, 80]
  • Default: none

If either dimension exceeds the size of the window in which the form is displayed, the form size is reduced to fit the window dimensions. If a console field cannot fit into the window, the program ends.

name
Form name, as used in a programming context in which the name is resolved at run time. If you use the name property, give it a value that is the same as the name of the variable.
  • Type: String
  • Example: name = "myForm"
  • Default: none

The name property is used in system functions such as consoleLib.displayFormByName.

showBrackets
Indicates whether the non-constant console fields are delimited by a pair of characters such as brackets.
  • Type: Boolean
  • Example: showBrackets = no
  • Default: yes

For more information, see the delimiters property.


Feedback