Boolean Fields

Changing Boolean Field Properties

Boolean fields are designed for use as simple on/off or yes/no parameters. Essentially a simplified choice field.

Changing Boolean Field Properties

Boolean field properties are adjusted directly in the property form.  Simply left-click on the boolean field to view its properties and content.

Boolean 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:

• 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.

• 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):

• 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:

• Animated: Select True or False. In order to utilize a value parameter field to control animated text label graphics, this property must be set as True. See Animated Graphics for more details.

• Text (Enabled State):  Enter a name for the enabled (true) state.  

• Text (Disabled State):  Enter a name for the disabled (false) state.

• Default Value:  Use this property to define the default value that will appear in the parameter field when a new component is created. Assume that a user who is not familiar with this component might simply accept your default value for lack of a better value.

Help:

• Help Text:  Enter a brief statement describing the field.  This text will be displayed on the actual input 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.  If Append is selected, then the prompt text will be appended to the other parameter attribute information displayed.