Text
The Text () form object is a predefined form for a text field with default text. It can either be static text that provides some information or editable text so that users can add notes or comments, for example. Enter the name of the text object in the Name field.
Select the Editable check box to make it possible for users to edit and add text. By default, the text is static.
The Wrap text check box is selected by default. Click it to disable wrapping of the text. A scrollbar appears if the text does not fit in its defined dimensions.
The Settings window contains the following sections.
Source
In this section, you define a source for the text object. The section contains a tree with a filtered view of the trees in the Application Builder and Model Builder windows. The nodes either represent some sort of data or have children that do. You can extend the list of available data nodes by clicking the Switch to Model Builder and Activate Data Access button () in the Source section header, which takes you to the Model Builder, and then selecting a node in the Model Builder branch whose data you want to access. With this button active, the Settings window of the selected node displays a Select Data Source check box (a green square) next to the settings that you can include. Click to select the check box to include that data as an available source node for text objects.
If the Editable check box is cleared so that the text is read-only, you can choose to use one of the following information nodes, which you find under the main Model node and under each Study node, as the source.
•
The Expected Computation Time node () under Model>Information (): The expected computation time is a value that the application developer can enter in the Expected field in the Root node’s Settings window.
•
The Last Computation Time node () under Model>Information: This node shows the last measured computation time for the last computed study.
•
The Last Computation Time node () under each Model>Study>Information: This node shows the last measured computation time for the study.
When you start an application for the first time, the last measured times are reset, displaying Not available yet.
When you select a node that represents data, the Use as Source toolbar button () below the tree is enabled. You can click it or, alternatively, press Enter, double-click, or right-click the node and choose Use as Source to add it as the selected source. You can also click the Create New Declaration and Use It as Source button () or the Create New Form Declaration and Use It as Source button () in the Source section header to create a new global or local (in the form) variable declaration for the text and use it as the source. A Create and Use Declaration dialog box opens so that you can select the data type of the source (if applicable), its name, and its initial value (if applicable). The name cannot be in conflict with any existing variable declaration. Click the Edit Node toolbar button () below the tree to move to the corresponding node. If necessary, the program switches to the Model Builder.
After selecting a node as the source, the node appears as the selected source under Selected source.
If you try to use the same data source in several form objects, you may encounter some strange side effects. The initial value for the source may not be what you expect. You may also experience serious errors if the initial value of one form object is invalid for one of the other form objects.
From the Initial value list, choose From data source (the default) to use the text from the source. Alternatively, choose Custom value to add text to display in the Value text field below.
Position and Size
This section contains all layout settings for a text object in the grid of the parent form.
In the grid mode, you can control the horizontal and vertical alignment of the text object using the following lists:
•
From the Horizontal alignment list, choose Left, Center, Right, or Fill, which automatically expands the form object to fill the cell in the horizontal or vertical direction (where applicable).
•
From the Vertical alignment list, choose Middle, Top, Bottom, or Fill, which automatically expands the form object to fill the cell in the horizontal or vertical direction (where applicable).
The need to specify the alignment is most obvious when working in the grid mode, as it controls how the form object is aligned in its grid cell. Aligning the form object can be useful in the sketch mode too, and you can then use the alignment tools on the Arrange menu in the Form toolbar’s Sketch section. When running the application in any client other than the Windows client, the form objects may not be positioned exactly as seen in the form windows. This is because the form objects may have a different size in other clients, giving them a slightly different positioning. Specifying the alignment ensures that the form objects are aligned as you want them to be in all clients.
You can also specify the width and height of the text input. Enter a width (in points) in the Width field and a height (in points) in the Height field. If you have chosen Fill from the Horizontal alignment list, you can instead specify a Minimum width. Choose Automatic to compute the minimum width automatically (typically this means a minimum size of 0), or choose Manual to specify a minimum width in the text field underneath. If you have chosen Fill from the Vertical alignment list, you can instead specify a Minimum height. Choose Automatic to compute the minimum height automatically (typically, this means a minimum size of 0) or choose Manual to specify a minimum height in the text field underneath.
Additionally, in the sketch mode, you can specify the absolute position of the text input using the Position x and Position y fields. In the grid mode, you can position the object in the grid and see the grid position as the Row, Column, Row span, and Column span values.
The form windows update these size and positioning settings through the draw operations performed there, such as resizing and moving the object.
Cell Margin
Under Cell margin (in grid mode only), you can control the margins around the form object. By default, the margins are taken from the parent form. From the Cell margin list, choose:
•
None, for no margin around the form object
•
From parent form (the default), to use the margins set for the parent form
•
Custom, to specify the margins for the form object in the Horizontal and Vertical text fields
Appearance
In this section, you can control the appearance of the background and the text.
From the Text color list, select a color to use for the text: Inherit (the default; the form object then uses the setting from the Form it is located in), any of the predefined basic colors, or Custom, which makes it possible to select a custom color from a color palette.
From the Background color list, select a color to use as the background for the text: Transparent (the default), any of the predefined basic colors, or Custom, which makes it possible to select a custom color from a color palette.
From the Text alignment list, select an alignment for the text: Left (the default), Center, or Right.
The font and the font size for the text use the font settings from the Forms node by default. Select a font from the Font list: Default font or any of the available fonts. If needed, choose or enter a font size (in points) in the Font size combo box. The default font size is Default size.
You can also select the Bold check box to use a boldface font or the Italic check box to use italics (an italic font).
Under State, you can control the initial state of the text object when users run the application. By default, the text object is visible and enabled. Clear the Visible or Enabled check box if you want to make the initial state so that the text object is hidden or unavailable. You can then make it visible or enable it using a method. In the Form Editor, the state of the form object is indicated by a change in its appearance. Objects that are hidden become visible when selected in the Form Editor.
Events
You can specify a method or command sequence that the application runs when the text changes. The On data change list contains None (the default) and any available methods or command sequence. You can add the following types of events by choosing from the Create Global Method menu () to the right of the On data change list:
•
Choose Create Global Method () to create a global method. Type the name of the global method in the Name field of the Create Global Method dialog box that opens and then click OK. The global method is then added under Methods, and its Method Editor window opens.
•
Choose Create Form Method () to create a form method. Type the name of the form method in the Name field of the Create Form Method dialog box that opens and then click OK. The form method is then added under the Methods node under the Form node, and its Method Editor window opens.
•
Choose Create Local Method () to create a local method. Its Method Editor window opens.
•
Choose Create Command Sequence () to create a command sequence using the Create Command Sequence dialog box that opens. There you can choose commands from the available Forms, GUI Commands, Declarations, Form Declarations, Methods, Form Methods, Libraries, and Model folders. To add a command, right-click the desired command node and choose the command to use (Run, for example). The command then appears in the list of commands below. You can edit that command sequence using the toolbar buttons for moving and deleting commands below the table. Click the Convert to Method button () and choose Convert to Method or Convert to Form Method to convert the command sequence to a method. Click the Go to Method button () below the table to select the method in the Application Builder tree and open the method in a Method Editor window. For commands that include arguments, click the Edit Argument button () to choose an argument in the Edit Argument dialog box that opens.
There can only be one local method and one command sequence so if you add one or both of them, the menu will instead contain Remove Local Method () and Remove Command Sequence (), respectively. Click one of them to delete the local method or command sequence.
The selected method in the On data change list then changes to the created method or command sequence. You can also Ctrl+Alt-click the text object or right-click it to create a local method or (by choosing Edit Method or Edit Local Method) to open the method associated with the command. To open the selected method or command sequence, click the Go to Source button (). The focus then moves to the method’s editor window or the Command Sequence dialog box, respectively.
For events triggered by data change, the event is triggered after the new data value is stored in the data source.
If you select more than one form object and they all support the On data change event, you can specify a method to, for example, make them inform users that plots and outputs are invalid.