Skip to main content
Version: 8.1

Vision - Text Field

Component Palette Icon:

Description

The Text Field component is used for input of any single-line text. This component will accept any alpha-numeric input. If you're looking for a numeric field, see the Vision - Numeric Text Field.

This field features a protected mode. When you enable the protectedMode property, the field is not editable even when it receives input focus. The user must double click on the field or press enter in order to edit the field. When they are done (press enter again or leave the field), the field becomes non-editable again.

The 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.

Properties

NameDescriptionProperty TypeScriptingCategory
BackgroundThe background color of the text box (when editable).Color.editableBackgroundAppearance
BorderThe border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.

Note: The border is unaffected by rotation.

Changed in 8.1.21
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
Commit On Focus LossIf true, any pending edit will take effect when focus is lost. If false, the user must press ENTER for an edit to take effect.boolean.commitOnFocusLostBehavior
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
Defer UpdatesWhen true, the 'text' property will not fire updates while typing, it will wait for Enter to be pressed.boolean.deferUpdatesBehavior
Editable?If true, this is an input box, if false, this is display-only.boolean.editableBehavior
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
Horizontal AlignmentDetermines the alignment of the label's contents along the X axis.int.horizontalAlignmentLayout
Maximum CharactersThe text box will be limited to this number of characters. Use -1 for unlimited.int.maxCharsBehavior
Mouseover TextThe text that is displayed in the tooltip which pops up when the user mouses over of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Non-Editable BackgroundThe background color to use when this text box is non-editable.Color.nonEditableBackgroundAppearance
Protected Mode?If true, users will need to double-click in the field in order to edit the text.boolean.protectedModeBehavior
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Reject Updates During EditIf true, this field will not accept updates from external sources (like DB bindings) while the user is editing the field.boolean.rejectUpdatesDuringEditBehavior
StylesContains the component's styles.Dataset.stylesAppearance
TextText of this component.String.textData
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
Touchscreen Keyboard Layout
New in 8.1.28
Sets the touchscreen keyboard layout to use for this component.
String.keyboardNameBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

Deprecated Properties

NameDescriptionProperty TypeScriptingCategory
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

Scripting

Scripting Functions

See the Vision - Text Field Scripting Functions page for the full list of scripting functions available for this component.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page

Customizers

Examples

Code Snippet
#The following code will return the value of the text box's previous value into a variable.
#This code is fired on the propertyChange event for this component.

oldValue = event.source.oldValue

Titled Panel

Property NameValue
BorderBevel (Raised)
FontDialog, Bold, 14
Horizontal AlignmentCenter