InputBox
The InputBox is used to display and edit numerical or textual values.
Use
Use on any page where numerical or textual values are to be displayed or edited.
Features
Numerical input
If the DataType is equal to number, the user input is checked for the following criteria:
- purely numerical input (letters and special characters are not allowed)
- minimum value (if MinValue is set)
- maximum value (if MaxValue is set)
The unit and number of decimal places for a numerical value can also be specified with the attributes Unit and Digits.
Attributes
The control inherits from TextControl and thus has the same attributes. In addition, there are the following attributes.
BA
BaObject
tchmi:framework#/definitions/Symbol
To use the generic functionalities of TcHmiBa. It links a single object or a complete view (including children) to the control.
 | You can find more detailed information about the generic possibilities of TcHmiBa under Generic HMI. |
Common
DataType
tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.InputBox.InputDataType
Data type of the InputBox. If auto is selected, the default value or the first input is analyzed and the data type is set accordingly. If number is selected Value does not contain the unit.
BaData
BaInterface
tchmi:framework#/definitions/Symbol
Allows linking a symbol that satisfies the BaInterface of the control. With this symbol all necessary data points of the control can be linked with only one binding.
BaInterfaceSymbolNames
tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.InputBox.BaInterfaceSymbolNames
Allows editing the BaInterfaceSymbolNames.
| The default values of BaInterfaceSymbolNames, as well as the expected data types can be found in the tooltip of the dialog for setting BaInterfaceSymbolNames: |
| Here is described how the BaInterfaceSymbolNames are overwritten by all controls of a type. |
Value
tchmi:framework#/definitions/TcHmi.BuildingAutomation.StringOrNumber
Current Value. Depending on the selected DataType the value is numerical or textual.
ValueFeedback
tchmi:framework#/definitions/TcHmi.BuildingAutomation.StringOrNumber
Feedback for the value.
UseValueFeedback
tchmi:general#/definitions/Boolean
If TRUE, then the ValueFeedback attribute is used.
Number
MinValue
tchmi:general#/definitions/Number
Lowest permissible input value (if DataType is equal to number).
MaxValue
tchmi:general#/definitions/Number
Largest permissible input value (if DataType is equal to number).
Unit
tchmi:framework#/definitions/TcHmi.BuildingAutomation.StringOrNumber
Determines the unit after Value (if DataType is equal to number). Possible values:
- textual (e.g. "°C")
- numerical (enumeration value of E_BA_Unit)
Digits
tchmi:general#/definitions/Number
Number of decimal places (if DataType is equal to number).
Events
Event | Description |
|---|---|
onStateChanged | Triggered when the value has changed. |
onUserInteractionFinished | Triggered when the user exits the input. This means:
|