Checkbox

The checkbox shows or edits binary values.

Use

Can be used on any page where binary values are to be displayed or edited.

Special features

The active and inactive text can be set (e.g. "On" / "Off").

The appearance can be customized using the Appearance attribute (see image above).

Possibility to link a BaObject to have to create only a single binding. All the required attributes are then linked via this binding and changes to the value are automatically written back to the PLC.

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

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. The attribute is not applicable to all controls.

Common

ActiveText

tchmi:general#/definitions/String

Specifies the text that is displayed if State is TRUE.

InactiveText

tchmi:general#/definitions/String

Specifies the text that is displayed if State is FALSE.

Appearance

tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.Checkbox.Appearance

Determines how the checkbox appears at the top.

Colors

CheckBackgroundColor

tchmi:general#/definitions/SolidColor

Background color of the checkbox if State is TRUE.

	This attribute has no effect if Appearance is set to ToggleSlider.

CheckmarkColor

tchmi:general#/definitions/SolidColor

Color of the check mark or toggle.

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

State

tchmi:general#/definitions/Boolean

State of the checkbox.

StateFeedback

tchmi:general#/definitions/Boolean

Feedback for the state of the checkbox.

UseStateFeedback

tchmi:general#/definitions/Boolean

Determines whether or not the attribute StateFeedback is used.

Events

Event	Description
onStateChanged	Triggered when the value of State has changed.
onUserInteractionFinished	Triggered when the user interaction with the checkbox has finished.