[Page]

Properties

implementationClassName

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.implementationClassName
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
No
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page
Copied!
Description
Classname which implements the form element.

renderingOptions._isCompositeFormElement

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions._isCompositeFormElement
Data type
bool
Needed by
Frontend
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  renderingOptions:
    _isTopLevelFormElement: true
    _isCompositeFormElement: true
    nextButtonLabel: 'next Page'
    previousButtonLabel: 'previous Page'
Copied!
Description
Internal control setting to define that the form element contains child form elements.

renderingOptions._isTopLevelFormElement

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions._isTopLevelFormElement
Data type
bool
Needed by
Frontend
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  renderingOptions:
    _isTopLevelFormElement: true
    _isCompositeFormElement: true
    nextButtonLabel: 'next Page'
    previousButtonLabel: 'previous Page'
Copied!
Description
Internal control setting to define that the form element must not have a parent form element.

renderingOptions.nextButtonLabel

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions.nextButtonLabel
Data type
string
Needed by
Frontend
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
Yes
Mandatory
No
Default value (for prototype 'standard')
Page:
  renderingOptions:
    _isTopLevelFormElement: true
    _isCompositeFormElement: false
    nextButtonLabel: 'next Page'
    previousButtonLabel: 'previous Page'
Copied!
Description
The label for the "next page" Button.

renderingOptions.previousButtonLabel

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.renderingOptions.previousButtonLabel
Data type
string
Needed by
Frontend
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
Yes
Mandatory
No
Default value (for prototype 'standard')
Page:
  renderingOptions:
    _isTopLevelFormElement: true
    _isCompositeFormElement: false
    nextButtonLabel: 'next Page'
    previousButtonLabel: 'previous Page'
Copied!
Description
The label for the "previous page" Button.

formEditor

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor
Data type
array
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.Page.editor.label.label
        propertyPath: label
      300:
        identifier: 'previousButtonLabel'
        templateName: 'Inspector-TextEditor'
        label: 'formEditor.elements.Page.editor.previousButtonLabel.label'
        propertyPath: 'renderingOptions.previousButtonLabel'
      400:
        identifier: 'nextButtonLabel'
        templateName: 'Inspector-TextEditor'
        label: 'formEditor.elements.Page.editor.nextButtonLabel.label'
        propertyPath: 'renderingOptions.nextButtonLabel'
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
    predefinedDefaults:
      renderingOptions:
        previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value'
        nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value'
    label: formEditor.elements.Page.label
    group: page
    groupSorting: 100
    _isTopLevelFormElement: true
    _isCompositeFormElement: true
    iconIdentifier: form-page
Copied!

formEditor.editors.100

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.100
Data type
array/ [FormElementHeaderEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor
Copied!

formEditor.editors.200

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.200
Data type
array/ [TextEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    editors:
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.Page.editor.label.label
        propertyPath: label
Copied!

formEditor.editors.300

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.300
Data type
array/ [TextEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Form:
  formEditor:
    editors:
      300:
        identifier: 'previousButtonLabel'
        templateName: 'Inspector-TextEditor'
        label: 'formEditor.elements.Page.editor.previousButtonLabel.label'
        propertyPath: 'renderingOptions.previousButtonLabel'
Copied!

formEditor.editors.400

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.400
Data type
array/ [TextEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Form:
  formEditor:
    editors:
      400:
        identifier: 'nextButtonLabel'
        templateName: 'Inspector-TextEditor'
        label: 'formEditor.elements.Page.editor.nextButtonLabel.label'
        propertyPath: 'renderingOptions.nextButtonLabel'
Copied!

formEditor.editors.9999

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.9999
Data type
array/ [RemoveElementEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    editors:
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
Copied!

formEditor.predefinedDefaults

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.predefinedDefaults
Data type
array
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    predefinedDefaults:
      renderingOptions:
        previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value'
        nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value'
Copied!
Description
Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.

formEditor._isCompositeFormElement

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isCompositeFormElement
Data type
bool
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  formEditor:
    _isCompositeFormElement: true
Copied!
Description
Internal control setting to define that the form element contains child form elements.

formEditor._isTopLevelFormElement

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isTopLevelFormElement
Data type
bool
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  formEditor:
    _isTopLevelFormElement: true
Copied!
Description
Internal control setting to define that the form element must not have a parent form element.

formEditor.label

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.label
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  formEditor:
    label: formEditor.elements.Page.label
Copied!
Good to know
Description
This label will be shown within the "new element" Modal.

formEditor.group

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group
Data type
string
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    group: page
Copied!
Default value
Depends (see concrete element configuration)
Description
Define within which group within the form editor "new Element" modal the form element should be shown. The group value must be equal to an array key within formElementGroups.

formEditor.groupSorting

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.groupSorting
Data type
int
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
Page:
  formEditor:
    groupSorting: 100
Copied!
Description
The position within the formEditor.group for this form element.

formEditor.iconIdentifier

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.iconIdentifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
Page:
  formEditor:
    iconIdentifier: form-page
Copied!
Description

An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry . This icon will be shown within