Workbench User Guide : Creating and Using Basic Fields : Scalar Fields : Create a Box Trim
 
Share this page          
Create a Box Trim
Box trim is a field type that appears as text within a rectangular boundary on a a form. If the text does not fit within the width of the box, OpenROAD automatically wraps the text and lengthens the box to accommodate the extra lines of text. If you move or resize the box, Workbench readjusts the text within the box.
To create a box trim field
1. Open your frame in the Frame Editor (see Open an Existing Frame).
2. Select the Box Trim icon on the field palette.
3. Position the cursor on the form's background and draw a box.
Note:  You do not need to be exact, because Workbench adjusts the box to accommodate the text.
When you release the mouse button, you are in Text Mode. Text Mode is the mode in which you can enter text in a box trim field. A blinking cursor indicates where to start entering text.
4. Enter sample box trim text, and then click the Select Mode icon on the field palette to exit Text Mode:
5. Select the box trim field to access its properties in the Property Inspector.
The text defaults to this field's StringValue property.
Note:  You can also enter the text directly in the value cell for the StringValue property. You can even insert several spaces before your text so that it is right-justified in the box. When you press Enter, the specified text defaults to the field on the form.
Note:  For complete descriptions of each field property, see Box Trim Properties and Common Field Properties.
Box Trim Properties
All the properties for box trim fields are described under Common Field Properties, with the exception of the following properties that are specific to the box trim field type:
CharsPerLine
Indicates the number of average-sized characters that a box trim, free trim, or entry field can display, thereby controlling the size of the field.
Note:  This number may differ from that specified for the MaxCharacters property. For example, suppose an entry field's data type is set to varchar(32), CharsPerLine is set to 10, and MaxCharacters to 32. The end user will be able to enter up to 32 characters, but the data in the entry field will scroll. When the entry field contains more characters than are visible, the end user can use the right and left arrow keys, and Home and End, to scroll through the entry field. The user can also insert and delete characters, using the Insert key to switch between overtype and insert mode.
StringValue
Displays the text of the field, exactly as it appears. For multiline entry fields, this property does not include any extra spaces added for word wrap, although it does include hard tabs and newline characters.
TextValue
Displays the first 256 characters of text in the field, exactly as they appear. If this field is an entry field, then this property holds the first 256 characters of data. For multiline entry fields, this property does not include any extra spaces added for word wrap, although it does include hard tabs and newline characters.
If this field is a box trim or free trim field, this property holds the first 256 characters.
UseWidestCharacter
Specifies whether a maximum character width must be used to calculate the field width. This property applies only to entry fields, box trim, and free trim. It is used in conjunction with the CharsPerLine property. Possible values are:
TRUE
Specifies that a maximum character width is used to calculate the field width
FALSE
Specifies that a maximum character width is not used to calculate the field width
WidestCharacterWidth
Specifies the width (in pixels) to use for characters if UseWidestCharacter is set to UWC_USER