Widget "TextInput" allows the user to enter text. Tapping the widget opens an on-screen keyboard automatically that can be used to enter text.
The on-screen keyboard has several different layouts to handle multiple languages. Switching takes place automatically when the language is switched. For currently supported layouts, see section Keyboard switching in the mapp View help documentation.
The following properties cannot be used in compound widget "Mapping":
zIndex, left, top, height, width
Appearance
|
|
Editor |
Web browser |
Properties
Type |
Description |
Bindable |
Necessary |
Default value |
|
ellipsis |
Defines whether a text that is too long should be indicated by an ellipsis, e.g. "This text is..." instead of "This text is too long". For more information, see here. |
|
|
false |
|
Defines the usability of the widget. A disabled widget (enable=false) does not react to user interaction and does not trigger events. The "disabled..." style is displayed at runtime. The "enable" behavior is inherited from the container widgets to the child widgets. |
|
|
true |
||
keyboard |
Defines whether an on-screen keyboard is used for entries. If keyboard=true, an on-screen keyboard is used and opens automatically as soon as input is required in the widget. If keyboard=false, it must be ensured that a hardware keyboard is available. |
|
|
true |
|
maxLength |
Defines the maximum number of characters that can be entered. If maxLength < 0, there is no limitation. |
|
|
-1 |
|
permissionOperate |
Defines the roles that are permitted to use the widget. For roles without sufficient rights, the widget does not react to user interaction and does not trigger events. |
|
|
|
|
permissionView |
Defines the roles that are permitted to see the widget. For roles without sufficient rights, the widget is hidden. |
|
|
|
|
Reference to a customizable widget style. |
|
|
default |
||
submitOnChange |
Defines whether changes, such as entry of a different value, should be submitted to the server immediately. Submit immediately = true. |
|
|
true |
|
placeholder |
Defines a message text that is displayed until the actual input takes place. |
|
|
|
|
inputRestriction |
Defines a regular expression used to check the widget's input value. The widget accepts all input that matches the regular expression. Only individually entered characters are taken into account (no character strings). |
|
|
|
|
This property can be used to display a text in the widget. |
|
|
|
||
Defines the visibility of the widget. The widget can be hidden with visible=false. (visible = true, hidden = false). The "visible" behavior is inherited from the container widget to the child widgets. |
|
|
true |
||
zIndex determines the z-order of the widget. With overlapping widgets, the zIndex determines which widget is on the top and which one is on the bottom. The widget with the larger zIndex is on top, and the one with the smaller zIndex is on the bottom. The zIndex must be unique within a piece of content or a container widget. The zIndex is automatically assigned by the visual editor and can therefore be changed via the toolbar. |
|
|
|
||
left |
Absolute position measured from the left border of the surrounded element (e.g. container widget or content). |
|
|
|
|
top |
Absolute position measured from the top border of the surrounded element (e.g. container widget or content). |
|
|
|
|
height |
Defines the total height of the widget in pixels. A value in % refers to the height of the surrounding element. |
|
|
30 |
|
width |
Defines the total width of the widget in pixels. A value in % refers to the width of the surrounding element. |
|
|
100 |
|
tooltip |
Defines the text that should appear as information when the tooltip indicator is pressed. You can use a static text or a text from the text system. For more information, see here. Mode "Tooltip" must be enabled for this. There are two different options for this: •Using action "ShowTooltip" •Using action "Client system" ShowTooltips. |
|
|
|
|
draggable |
Defines whether the widget can be dragged at runtime. This can be used to perform actions or establish relationships between two widgets. If true, the widget can be moved onto another widget. The source widget remains in its position and a copy is created and dragged. Actions OnDragStart and OnDragEnd can be used. If false, the widget cannot be moved. For more information, see here. |
|
|
false |
|
tabIndex |
Property tabIndex is used to manage the tab order during keyboard operation. For additional information, see Keyboard operation. ENTER triggers event Click if tabIndex ≥0. According to the OnStart configuration in the HMI application, a text can be entered and applied accordingly with OnEnd. |
|
|
0 |
Styleable properties
Type |
Description |
Default value |
|
borderWidth |
Defines the width of the border around the widget. |
2px 6px 2px 2px |
|
cornerRadius |
Defines the corner style of the widget. |
2px |
|
backColor |
Defines the background color of the widget. |
#F7F7FF |
|
disabledBackColor |
Defines the background color of the widget in the disabled state. |
#F1F1F1 |
|
backGroundGradient |
Defines the background color of the widget as a color gradient. |
|
|
disabledBackGroundGradient |
Defines the background color of the widget as a color gradient in the disabled state. |
|
|
borderColor |
Defines the color of the border around the widget. |
#555555 |
|
disabledBorderColor |
Defines the color of the border around the widget in the disabled state. |
#C8C8C8 |
|
disabledBorderWidth |
Defines the width of the border around the widget in the disabled state. |
2px 6px 2px 2px |
|
borderStyle |
Defines the style of the border around the widget. Borders can be unbroken, dashed or dotted. |
solid |
|
textColor |
Defines the color used to display the text. |
#333333 |
|
disabledTextColor |
Defines the color of the text in the disabled state. |
#C8C8C8 |
|
activeBorderColor |
Defines the color of the border around the widget during operation. |
#FF8800 |
|
activeBorderWidth |
Defines the width of border around the widget during active operation. |
2px 6px 2px 2px |
|
activeBackColor |
Defines the background color of a widget during operation. |
#F7F7FF |
|
activeTextColor |
Defines the color used to display the text during operation. |
#333333 |
|
textAlign |
Defines the orientation of the text. |
right |
|
opacity |
Defines the transparency of the widget. The lower the value, the more transparent the widget. |
1 |
|
fontName |
Defines the font used for the text shown. |
Arial |
|
fontSize |
Defines the size of the font used to display the text. |
21px |
|
bold |
Defines whether the text is shown in bold. |
false |
|
rotation |
Defines the rotation of the widget, e.g. a value of 90 degrees changes the rotation of the widget by 90 degrees clockwise. |
0deg |
|
italic |
Defines whether the text is shown in italics. |
false |
|
shadow |
Defines the shadow of the widget. |
none |
|
padding |
Defines the spacing between the outer boundary of the widget and its content. For more information, see here. |
0px 15px 0px 15px |
|
margin |
Defines the offset of the external boundary of the widget to the widget's actual set position. For more information, see here. |
0px |
|
placeholderTextColor |
Defines the color of the message text. |
#C8C8C8 |