InputBox

The InputBox is used to display and edit numerical or textual values.

InputBox 1:

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:

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.

Feedback concept

The control can use the feedback concept.

BA

BaObject

tchmi:framework#/definitions/Symbol

Symbol for BaObject for using the generic functionalities of TcHmiBa. Links a single object or a complete view (including children) to the control.

InputBox 2:

The attribute is not applicable to all controls.

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.

Text (read-only)

tchmi:general#/definitions/String

The displayed text.

BaData

BaInterface

tchmi:framework#/definitions/Symbol

Symbol that fulfills the BaInterface of the control.

BaInterfaceSymbolNames

tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.InputBox.BaInterfaceSymbolNames

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:

  • Enter key is pressed
  • InputBox loses focus