Text Input

Text Input

The Text Input graphic element is a control with built-in animation properties to show a string tag value and open the virtual keyboard to change the value. Text Input appears under
CommonControls
in the Toolbox.
Use the Text Input graphic element to show messages from the data source on the HMI device, and write a new value to the data source. By default, the
Virtual Standard Keyboard
 opens in
PanelView
 projects when interacting with a Text Input graphic element.
Make the value you enter by selecting the
MaskedValue
 box in the
Properties
window. For example, select
MaskedValue
 to have users not see their passwords while they type them.
Bind the
Text
 box in the
Properties
window to a string tag, a numeric tag, or an expression to display information from the data source. Write a new value to the tag on the HMI device using the virtual keyboard. If you enter an invalid value, the value does not write to the tag and an error appears. For example, if the
Text
 property is bound to an INT tag, writing the value "abc" to the tag is not supported.
TIP:
Tips:
  • Do not place text against the border of a graphic element. Allow for a small difference in space, such as one or two characters. If placing text against the border of a graphic element, the text may wrap differently or appear clipped on the HMI device.
  • The maximum length of a text input is 82 characters.
  • To change the method for entering values in this graphic element, change the ValueEntryMethod property for the graphic element. The ValueEntryMethod property specifies whether entering values is inherited from the project properties, performed through the
    Virtual Numeric Keypad
    .

Built-in animation properties

Built-in animation properties appear under the
General
category of the
Properties
window. Specify values for these properties in order to animate the graphic element or change the information the graphic element shows on the HMI device.
Property
Category
Purpose
Accepted Values
Text
General
Specifies the text on the graphic element.
Do not place text against the border of a graphic element. Allow for a small difference in space, such as one or two characters. If you place text against the border of a graphic element, the text may wrap differently or appear clipped on the HMI device.
Alpha-numeric characters

Unique properties

Unique properties are properties that not all graphic elements in the
Toolbox
share.
Property
Category
Purpose
Accepted Values
CornerRadius
Appearance
Specifies the curve of the corners.
0 or a positive number
FillColor
Appearance
Specifies the fill color.
Any selected color in the
Color Picker
 or a Hex color value entered manually. The Hex value must be in the format #RRGGBB. R, G, and B are Hex digits from 0 through F and represent the color channel values for red, green, and blue. For example, #ffff00 produces yellow.
TextAlignment
Appearance
Specifies the vertical and horizontal alignment of the text.
Vertical alignment:
  • Top
  • Center
  • Bottom
    Horizontal alignment:
  • Left justified
  • Centered
  • Right justified
Color
Appearance/Border
Specifies the color of the border.
Any selected color in the
Color Picker
 or a Hex color value entered manually. The Hex value must be in the format #RRGGBB. R, G, and B are Hex digits from 0 through F and represent the color channel values for red, green, and blue. For example, #ffff00 produces yellow.
Style
Appearance/Border
Specifies the style of the border line.
  • Any selected Line style - None, Solid, Dash, Dot, Dash Dot, or Dash Dot Dot
  • Any selected Cap style - Flat, Round, or Square
  • Any selected Join style - Miter, Bevel, or Round
Width
Appearance/Border
Specifies the width of the border line.
  • None
  • 1 point
  • 2 point
  • 4 point
  • 8 point
FontName
Appearance
Specifies the font of the text.
Any selected font
FontColor
Appearance
Specifies the color of the text.
Any selected color in the
Color Picker
 or a Hex color value entered manually. The Hex value must be in the format #RRGGBB. R, G, and B are Hex digits from 0 through F and represent the color channel values for red, green, and blue. For example, #ffff00 produces yellow.
FontSize
Appearance
Specifies the size of the text.
Positive numbers
Bold
Appearance
Makes the text or value on the graphic element bold.
  • Bold - selected
  • Not bold - cleared
Padding
Appearance
Specifies the distance, in points, between the content of the element and the edge of the element.
Any numeric value
UsePredefinedDisabled
Appearance
Specifies if a crosshatch overlay shows on the control element when you disable the element.
  • Use predefined disabled appearance
    (selected)
  • Do not use predefined disabled appearance
    (cleared)
MaskedValue
Input
Specifies that asterisks mask the value entered on the numeric keypad.
  • Value masked (selected)
  • Value not masked (cleared)
KeypadMinValue
Input
Specifies the minimum value to show and enter on the numeric keypad
Any numeric value that is less than the KeypadMaxValue property value
KeypadMaxValue
Input
Specifies the maximum value to show and enter on the numeric keypad.
Any numeric value that is greater than the KeypadMinValue property value
ValueEntryMethod
Input
Specifies the method for entering values in the graphic element. The default is to inherit the value entry method from the project. Selecting the virtual keyboard value entry method overrides the default setting of the project.
  • InheritProjectSetting
  • VirtualKeyboard
    Bind to the name of a value or the associated number:
  • 0 (InheritProjectSetting)
  • 1 (VirtualKeyboard)

Common properties

Common properties exist for all graphic elements.
Property
Category
Purpose
Accepted Values
Access
Security
Specifies if all users have access to the control element, or if access is inherited from the screen.
  • Inherit - Access inherited from screen.
  • Full Access - Access granted to all users.
Angle
Position and Size
Specifies the rotation angle.
Enter 180 to display the graphic element upside down. If you enter a value larger than 360, the portion of numeric value that is over 360 becomes the value. For example, enter 380 to see a value of 20. If you enter a value less than 0, the negative value is subtracted from 360. For example, enter -30 to see a value of 330.
  • Numbers 0 to 360
Enabled
Appearance
Specifies if the graphic element is available on the HMI device and if the graphic element accepts touch and key input.
  • Enabled - selected
  • Not Enabled - cleared
Height
Position and Size
Specifies the height in pixels.
Any positive numeric value
Opacity
Appearance
Specifies the transparency of the graphic element.
0 (fully transparent) - 100 (fully opaque)
Visible
Appearance
Specifies if the graphic element is visible on the HMI device.
  • Visible - selected
  • Not visible - cleared
Width
Position and Size
Specifies the width in pixels.
Any positive number
X
Position and Size
Specifies the horizontal coordinate, in pixels, from the upper left corner of screen to the upper left corner of a graphic element or group with no rotation. If the graphic element or group is rotated, the X property value does not change.
Any positive number
Y
Position and Size
Specifies the vertical coordinate, in pixels, from the upper left corner of screen to the upper left corner of a graphic element or group with no rotation. If the graphic element or group is rotated, the Y property value does not change.
Any positive number
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.