String Field

<< Click to Display Table of Contents >>

Navigation:  Object Reference > Palette Objects >

String Field

The string field object is designed to show text on the screen. It can be customized like any other object using it's properties.

The string field has a lot of common properties. See here for a description of them. Here only the string field specific properties are described.

 

Besides the Auto Wrap property, Texts in String Fields can also have custom line breaks by inserting "\n" (without the "") in the text.

The line break can also be included at runtime via JavaScript by adding \n in a String variable and having that referenced to the String Field or, alternatively by putting the text into the String Field with setProperty.

 

Please note that for existing projects in the rare case the text "\n" should be used in a String Field, this will now be interpreted as a line break.

In that case, please change "\n" to e.g. "\ n" to avoid the line break.

 

 

hmtoggle_plus1String Field Specific Properties

Auto Wrap

When Auto Wrap is enabled, the text inside the string field will be automatically wrapped to the next line if the text does not fit inside the string field. If possible, wrapping will leave the words in the text complete. If the string field is to narrow to display even a single word, the single word will be splited.

If Auto Wrap is disabled, text that does not fit in the string field will be clipped.

Default value: Disabled

Possible values: Disabled or Enabled

Max String Length (Characters)

The maximum length of the text displayed in the string field can be adjusted with this property.

Note that the value of a referenced variable or the Preview Value of the string field may have more characters but they are just not displayed if it's more than Max String Length.

Default value: 32

Possible values: 0 ... 65536

 

Too Long Text Behavior

If the text of a String Field is longer than it can be displayed, a number of different options can be chosen here.

Note that these options are only taken into account if Auto Wrap is disabled and no line break has been added to the text, otherwise No Clip will be used.

 

Default value: No clip

Possible values:
No clip - The text is displayed in full, even if it extends the width of the String Field

Clip - The text is clipped (cut) so that it fits the width of the String Field. The horizontal alignment decides which part of the text is displayed.

Shorten and add ... - The text is cut and three dots are added at the end. This selection overrides the horizontal alignment and sets it to left.

Animate - The text is displayed within the width of the String Field and slowly animated from left to right so that all text is displayed.
hmtoggle_plus1Events

The following events can be configured for the string field object:

•OnOpenForInput

•OnEnabledWithFocus

•OnEnabledWithoutFocus

•OnValueChange

•OnEnterValue

•OnEnterNewValue

•OnEscape

See here for the descriptions of all event and possible actions that can be assigned.