Mashup Builder > Widgets > Standard Widgets > Text Field Widget (Themable)
Text Field Widget (Themable)
The Text Field widget is an input element that is commonly used within forms. You can use a Text Field to enable users to type text in a mashup. You can set or retrieve the text within the field using the Text property. Unlike the Text Area widget, the Text Field is limited to a single line. In addition to the common widget properties, you can configure the widget using properties in the following ways:
Configure the maximum number of characters and add a counter.
Use the text as an input for data services, functions, and other widgets.
Show hint text when a value is not set.
Add a clear text button.
Enable read-only mode.
Hide the input for sensitive information such as passwords.
Define a mask pattern to make sure that the input is a specific format.
* 
The Text Field widget is available as a standard widget in the platform and as a web component that can be imported from the Web Component SDK.
You can use the following widget events to execute data services or functions when the widget is value is updated at run time:
EnterKeyPressed—Triggers when the ENTER key is pressed.
FocusLost—Triggers when an area outside the widget is clicked or the TAB key is pressed.
Working with Events
The Text Field widget triggers two bindable events:
Changed—Triggers when a character is added or removed.
EnterKeyPressed—Triggers when a user presses the Enter key.
You can use the widget events to trigger functions, data services, or services within widgets. For example, you can bind the events to a Validator function to validate the input as it is typed or when the Enter key is pressed.
Enabling Read Only Mode
You can enable the ReadOnly property to prevent changes to the text at run time. For example, you can use this property to prevent changes until a toggle button is enabled or a check-box is selected in the mashup. When read-only is enabled, you can select and copy text, but you cannot edit, cut, or delete the current value. To change the text value of a read-only Text Field, enter a value for the Text property at design time. You can also bind a data source to the property to change the text value at run time.
Setting a Limit on the Number of Characters
You can limit the input from the text field to a specific number of characters in one of the following ways:
Set the MaxNumberOfCharacters property to any numeric value. By default, the text field supports up to 100 characters.
Define a mask pattern using the Mask property. The number of special characters within the pattern is used to set the character limit.
Adding a Counter to the Text Field
To add a counter that shows the number of characters in the text field, set the Counter property to True. The MaxNumberOfCharacters property is used to set the character limit, including whitespace. The following image shows the Text Field widget with a visible counter and a maximum character count of 10:
When the character limit is reached, the counter color changes:
Adding a Clear Text Button
You can enable the ShowClearText property to add a text button to the input box of the widget. The button appears automatically to the right side of the widget when the input field contains a value. This enables users to quickly remove any existing text within the widget.
Configuring the Text Field Input Pattern
You can use the Mask property to specify an input pattern for numeric, alphabetic, and alphanumeric characters. When you define a pattern, placeholder guides are added to the input box. The guides are lines that are used to indicate the text pattern that a user can type into the text field. In addition to the required pattern, the property sets the number of characters within the text field. You can create patterns using the following special characters:
a—Alphabetic
9—Numeric
*—Alphanumeric
To create a pattern, combine the special characters into a string that represents the required input. For example, the following patterns represent different types of inputs:
9999—A four-digit number
*****—Five alphanumeric characters
99–aa—A two-digit number, followed by a separator dash and two alphabetic characters.
The following image shows the guides for a 999–999–999–999 numeric pattern that contains four three-digit numbers at run time:
The pattern is used to set the format of the number in addition to the number of digits. In this example, you can type any 12 digit number, such as: 256120233234. As you type, the underscore (_) guides are replaced by numbers.
The indicator guides are displayed based on the total number of characters that you set within the pattern during design time. When you type a number with fewer digits than the pattern, the input remains incomplete. You should use the mask to define patterns with a specific number of characters, such as a phone numbers or Zip codes. Avoid using a mask when the input is not a specific number of characters, such as a monetary amount.
* 
You can use different types of symbols such as periods, dashes, slashes, and more as separators between characters.
* 
The Text Field widget is available as a standard widget in the platform and as a web component that can be imported from an SDK.
The properties of the Text Field widget are listed below.
Property Name
Description
Base Type
Default Value
Bindable? (Y/N)
Localizable? (Y/N)
Text
The text that is displayed in the text field.
STRING
n/a
Y
Y
Label
The text that is displayed in the label of the text field.
STRING
n/a
Y
Y
Counter
Counts and displays the number of characters that are entered in the text field.
BOOLEAN
False
N
N
MaxNumberOfCharacters
Enables you to set a maximum number of characters in the textfield.
NUMBER
100
Y
N
HintText
Displays placeholder text that explains what should be entered in the field.
STRING
n/a
N
Y
Disabled
Use this property to disable the widget in the mashup. The widget is displayed in the mashup but you cannot click it.
BOOLEAN
False
Y
N
ReadOnly
Enables you to set the text field as read-only and the user cannot edit the text.
BOOLEAN
False
N
N
Password
Enables you to hide the text field entry.
BOOLEAN
False
N
N
ShowClearText
Enables you to add a Clear button inside the text field, which allows the user to clear the text in the field at run time when the button is clicked.
BOOLEAN
True
N
N
LabelAlignment
Enables you to align the label to the left, right or center.
STRING
Left
N
N
TextAlignment
Enables you to align the text to the left or right in the field.
STRING
Left
N
N
Mask
Enables you to set predefined characters in the text field. In the property configuration field, use “a” to set a alphabetic entries, “9” for numeric entries, and “*” for alphanumeric entries.
STRING
n/a
N
N
TabSequence
The sequence of the widgets in which they are highlighted when the user presses Tab key.
NUMBER
n/a
N
N
CustomClass
Enables you to define the CSS to the top div of the widget. Multiple classes can be entered, separated by space.
STRING
n/a
Y
N
EnterKeyPressed
An event that is triggered when the ENTER key is pressed while editing the text value.
* 
In ThingWorx 9.1 and earlier, this event is also triggered when an area outside the widget is clicked.
n/a
n/a
Y
N
FocusLost
An event that is triggered when a user changes the focus by pressing the TAB key or by clicking an area outside the widget while editing the text value.
* 
This property is available in ThingWorx 9.2 or later.
n/a
n/a
Y
N
Changed
The event that is triggered when the data of this widget is modified.
n/a
n/a
Y
N
ResetToDefaultValue
Resets the inputs for this widget to their default values.
n/a
n/a
Y
N
Width
The width of the widget.
NUMBER
273
N
N
Height
The height of the widget. It is automatically calculated by default. The height increases if you include a label within the text field.
NUMBER
Autosize
N
N
TooltipField
Sets a tooltip text that is displayed when you hover over the widget.
STRING
n/a
Y
Y
TooltipIcon
Sets an icon image for the tooltip of the widget.
You can add an image or specify an image URL path.
MEDIA ENTITY
n/a
N
N
Was this helpful?