Changing Text Field Properties
Text fields are used primarily to add descriptive comments, used for identification of the component within source code or graphical display (using text labels). They may also be used to define signals to be used as internal output variables within the component.
Text field properties are adjusted directly in the property form. Simply left-click on the text field to view its properties and content.
Text Field Property Form
Appearance:
Display Name: Enter a caption to act as the visible title of the parameter field.
Symbol: Enter a symbolic name for the parameter field, which will be used as a variable name when addressing this parameter within code. Note that this name must be compatible with standard Fortran naming conventions (i.e. it must begin with a non-numeric character, do not include spaces, etc.).
Behaviour:
Allow Empty String: Select True to allow this parameter field to contain an empty string.
Condition: Enter an expression (optional) to indicate under what conditions the parameter field is to be enabled. See Expressions Statements and Operators for more details.
Error Message: Enter a message to be output if the expression entered in Regular Expression fails.
Group: Use this property to organize (or group) the display of the fields in the parameter form. All parameter fields that possess the same group name will be grouped together under the group name heading. For example, the image below shows part of an parameter form, where the fields have all been given the same group name (in this case Positive Sequence):
Maximum Length: Enter the maximum number of characters allowed in this field. Enter 0 for no maximum limit.
Minimum Length: Enter the minimum number of characters allowed in this field. Enter 0 for no minimum limit.
Regular Expression: Enter an expression for the purpose of ‘masking’ the entered value for this parameter field. Regular expression (or Regex) is a powerful language used for the recognition of character patterns. As the designer, you can use this language to ensure that users of your component enter data values in a specific format. For more details on regular expressions, see http://en.wikipedia.org/wiki/Regex.
Visibility: Enter an expression (optional) to indicate under what conditions the parameter field is to be visible. See Expressions Statements and Operators for more details.
Data:
Default Value: Use this property to define the default text that will appear in the parameter field when a new component is created.
Help:
Help Text: Enter a brief statement describing the field. This text will be displayed on the parameter dialog for the component.
Help Mode: Select Append or Overwrite. If Overwrite is selected, only the help text will appear at the bottom of the dialog when the user selects this parameter field. If Append is selected, then the prompt text will be appended to the other parameter property information displayed.
|
|
Append |
Overwrite |
