You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.


Component Palette Icon:


The Text Field component is used for input of any single-line text. This component will accept any alpha-numeric input.

If you need a field that accepts multiple lines of text, see the Perspective - Text Area component. If you're looking for a numeric field, see the Perspective - Numeric Entry Field component.


Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
textText to display.value: string
placeholderText displayed when Text Field is empty.value: string

If true, user is allowed to alter text.

If the component is disabled, scripts can still run on the component. For example, if you add a script action to the onClick event, the script will fire when the user clicks on the Text Field.

value: boolean


The following feature is new in Ignition version 8.0.3
Click here to check out the other new features

When true, updates to props.text will be deferred until focus is lost or enter is pressed.

value: boolean


The following feature is new in Ignition version 8.0.3
Click here to check out the other new features

When true, props.text will not accept updates from external sources while focused.

value: boolean


Sets a style for this component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.


User Interaction

The Text Field component properties have impact on the way a user can interact with a table in the runtime.


When the enabled property is set to true, a user can edit the text field in the runtime. The user must double click on the field or press enter in order to edit the field. When done, press enter or leave the field, and the text field becomes non-editable again.

When the enabled property is set to false, it is not editable even when it receives input focus.

GeneralThe Text Field also supports the reject updates during edit feature. This feature ignores updates coming from property bindings while the component is being edited by a user.

Perspective Component Events

The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.


This example shows the Text Field in two states: the top image is with text entered and the bottom image is without text entered. 

props.textLab Results from QA: Chem Analysis OK
props.placeholderSingle Line Entry

  • No labels