The restrictions object holds flags about the restrictions configured against the field. Restrictions control what manipulations are possible within the editor UI.

Hierarchy

Properties

allowRotation: boolean

Flag to control if the field can be rotated.

allowSizeChange: boolean

Flag to control if the field can be resized.

allowZOrderArrangement: boolean

Flag to control if the z-index of the field can be adjusted.

doNotDelete: boolean

Flag to control if the field can be deleted (either with the UI or the 'Delete' key).

doNotOpenPopup: boolean

Flag to control if the selected field can show the popup dialog specific to that field type.

doNotParticipateOnLayout: boolean

Flag to control if the field should be used when layouts are applied. If the field does not participate, the contents of the field are ignored when transfering data. When layouts are generated, those fields will be ignored too.

doNotPrint: boolean

Flag to control if the field should be added to the print output. If this flag is set, the field would not appear in the output even if the field is visible. This flag will also control the preview - and that means that it would also mean the field would not show up there either.

doNotSelect: boolean

Flag to control if the field can be selected. If disabled, the field will not interact with the mouse and cannot be selected. Fields below the current field can then be interacted with.

movementMode: FieldMovementMode

The movement mode controls how the field can be moved.

showNoPrintInPreview: boolean

Only relevant if doNotPrint is set to true. This flag controls if the field should be shown in the preview despite 'doNotPrint' being set to true.

skipPageZoom: boolean

The editor will establish the default zoom level for all fields to ensure everything is visible initially. This flag allows to ignore the current field when calculating the zoom level.

Generated using TypeDoc