Skip to content

Checkbox field

The checkbox field is used to represent a boolean value (true/false) in documents.


Setting Required Description
Label Yes The label is used for users of BizzStream. The label is shown in documents left to the value of the field. Labels can always be edited.
Translation key No Can be used to replace the field label with a translation. If set, BizzStream will try find the translation associated with the key set in this field. If no translation can be found, the label set in the Label field will be used.
Name Yes The name is a BizzStream system field. Once the Document Definition is persisted, this field cannot be edited anymore. Unless there are no documents based on this document definition.
Initial Value No By providing an initial value to the field, upon creation the field or linefield will have this value. This field cannot refer to values placed in other fields. A user/visitor can overwrite this value.
Initial Placeholder No When you provide an initial placeholder, the field will get the value of the field to which the placeholder refers. Users/visitors can update this value. Unlike placeholders, the field will not updated when the field to which the placeholder refers updates. This field can contain BizzStream Expressions referring to other fields.
Placeholder No By providing a placeholder, you ensure that the value of this field is replaced by the value of the field to which the placeholder refers when the referenced field updates.

How the data is stored

The checkbox values are saved as a boolean into the database:

checkboxField: true