Common properties of all fields

Property

Description

required

Example

type

With this property you select one of the existing components. Depending on the component, certain properties are not needed and/or new properties are added.

All existing components are listed and explained in the following articles.

images/s/ti67az/8401/0f22f74a0c673511e48ab1bc7ae6af4388aa8dbf/_/images/icons/emoticons/check.svg

"type": "is-search-field"

model

Here you specify which property of the entity is to be displayed and edited.

images/s/ti67az/8401/0f22f74a0c673511e48ab1bc7ae6af4388aa8dbf/_/images/icons/emoticons/check.svg

"model": "entity.AdrNr"

name

Here you enter the text that is displayed in the label in front of the field.

Translations can also be entered here.


"name": "{{{Adresse.Adresse}}}"

readOnly

Here you specify whether the field is to be write-protected or not. You can also specify here the conditions that must be fulfilled for the write protection to be activated or deactivated. If the user does not have write access to the opened entity, this property is ignored and the field cannot be edited by the user.


"readOnly": "!addressSearchEnabled || !entity.IsNew"

visible

Here you can specify whether the field is displayed or not.


"visible": true

visibleCondition

Here you can set a condition at which the field is displayed or hidden.


"visibleCondition": "entity.IsNew || entity.KennungTyp == 5"

required

Here you define with a Boolean value whether the field is a mandatory field or not.


"required": true

labelAndControlCombined

If this boolean property is set, only the field is displayed instead of the label and the field. This then extends over the whole region.


"labelAndControlCombined"true

leftContainerStyle

With this property you can still format the left container with CSS.


"leftContainerStyle": {
"width": "100px",
"color": "blue"
}

rightContainerStyle

With this property you can still format the right container with CSS.


"rightContainerStyle": {
"width": "55%"
}

defaultValue

Enter a default value for the field here. If the field is empty, this default value is entered. Furthermore, it is possible to determine the default value via an individual Api end point. You can find more on this here.


"defaultValue": 1

isKey

Works similar to the "required" and "visibleCondition" properties. If the value being edited here is a key, you can assign the boolean value "true". This makes this value "required" for a new creation and it can no longer be edited after saving.


"isKey" : true

title

If an additional note should be placed, you can enter it here.


"title": "{{{WebSMS.Procedure.RectificationCode}}}"

dc1

If you would like to have your own component below the field, you can enter it here as an object. Use "modulName" to enter the path and name of the desired component. If the component requires further individual parameters, these can be specified under "customProps".


"dc1": {
"moduleName": "app/parts/transLink",
"customProps": {
"data": {
....
}
}
}

extendedView

This property specifies whether the field should be hidden by default and can only be shown via a corresponding action.


"extendedView": true