[Page]¶
Properties¶
implementationClassName¶
- Option path
TYPO3.CMS.Form.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')
1Page: 2 implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\Page
- Description
Classname which implements the form element.
renderingOptions._isCompositeFormElement¶
- Option path
TYPO3.CMS.Form.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')
1Page: 2 renderingOptions: 3 _isTopLevelFormElement: true 4 _isCompositeFormElement: true 5 nextButtonLabel: 'next Page' 6 previousButtonLabel: 'previous Page'
- Description
Internal control setting to define that the form element contains child form elements.
renderingOptions._isTopLevelFormElement¶
- Option path
TYPO3.CMS.Form.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')
1Page: 2 renderingOptions: 3 _isTopLevelFormElement: true 4 _isCompositeFormElement: true 5 nextButtonLabel: 'next Page' 6 previousButtonLabel: 'previous Page'
- Description
Internal control setting to define that the form element must not have a parent form element.
renderingOptions.nextButtonLabel¶
- Option path
TYPO3.CMS.Form.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')
1Page: 2 renderingOptions: 3 _isTopLevelFormElement: true 4 _isCompositeFormElement: false 5 nextButtonLabel: 'next Page' 6 previousButtonLabel: 'previous Page'
- Description
The label for the "next page" Button.
renderingOptions.previousButtonLabel¶
- Option path
TYPO3.CMS.Form.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')
1Page: 2 renderingOptions: 3 _isTopLevelFormElement: true 4 _isCompositeFormElement: false 5 nextButtonLabel: 'next Page' 6 previousButtonLabel: 'previous Page'
- Description
The label for the "previous page" Button.
formEditor¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor
- Data type
array
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 editors: 4 100: 5 identifier: header 6 templateName: Inspector-FormElementHeaderEditor 7 200: 8 identifier: label 9 templateName: Inspector-TextEditor 10 label: formEditor.elements.Page.editor.label.label 11 propertyPath: label 12 300: 13 identifier: 'previousButtonLabel' 14 templateName: 'Inspector-TextEditor' 15 label: 'formEditor.elements.Page.editor.previousButtonLabel.label' 16 propertyPath: 'renderingOptions.previousButtonLabel' 17 400: 18 identifier: 'nextButtonLabel' 19 templateName: 'Inspector-TextEditor' 20 label: 'formEditor.elements.Page.editor.nextButtonLabel.label' 21 propertyPath: 'renderingOptions.nextButtonLabel' 22 9999: 23 identifier: removeButton 24 templateName: Inspector-RemoveElementEditor 25 predefinedDefaults: 26 renderingOptions: 27 previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value' 28 nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value' 29 label: formEditor.elements.Page.label 30 group: page 31 groupSorting: 100 32 _isTopLevelFormElement: true 33 _isCompositeFormElement: true 34 iconIdentifier: form-page
formEditor.editors.100¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.100
- Data type
array/ [FormElementHeaderEditor]
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 editors: 4 100: 5 identifier: header 6 templateName: Inspector-FormElementHeaderEditor
formEditor.editors.200¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.200
- Data type
array/ [TextEditor]
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 editors: 4 200: 5 identifier: label 6 templateName: Inspector-TextEditor 7 label: formEditor.elements.Page.editor.label.label 8 propertyPath: label
formEditor.editors.300¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.300
- Data type
array/ [TextEditor]
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Form: 2 formEditor: 3 editors: 4 300: 5 identifier: 'previousButtonLabel' 6 templateName: 'Inspector-TextEditor' 7 label: 'formEditor.elements.Page.editor.previousButtonLabel.label' 8 propertyPath: 'renderingOptions.previousButtonLabel'
formEditor.editors.400¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.400
- Data type
array/ [TextEditor]
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Form: 2 formEditor: 3 editors: 4 400: 5 identifier: 'nextButtonLabel' 6 templateName: 'Inspector-TextEditor' 7 label: 'formEditor.elements.Page.editor.nextButtonLabel.label' 8 propertyPath: 'renderingOptions.nextButtonLabel'
formEditor.editors.9999¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.editors.9999
- Data type
array/ [RemoveElementEditor]
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 editors: 4 9999: 5 identifier: removeButton 6 templateName: Inspector-RemoveElementEditor
formEditor.predefinedDefaults¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.predefinedDefaults
- Data type
array
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 predefinedDefaults: 4 renderingOptions: 5 previousButtonLabel: 'formEditor.elements.Page.editor.previousButtonLabel.value' 6 nextButtonLabel: 'formEditor.elements.Page.editor.nextButtonLabel.value'
- Description
Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.
formEditor._isCompositeFormElement¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isCompositeFormElement
- Data type
bool
- Needed by
Backend (form editor)
- Mandatory
Yes
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 _isCompositeFormElement: true
- Description
Internal control setting to define that the form element contains child form elements.
formEditor._isTopLevelFormElement¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor._isTopLevelFormElement
- Data type
bool
- Needed by
Backend (form editor)
- Mandatory
Yes
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 _isTopLevelFormElement: true
- Description
Internal control setting to define that the form element must not have a parent form element.
formEditor.label¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.label
- Data type
string
- Needed by
Backend (form editor)
- Mandatory
Yes
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 label: formEditor.elements.Page.label
- Good to know
- Description
This label will be shown within the "new element" Modal.
formEditor.group¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group
- Data type
string
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 group: page
- 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. Thegroup
value must be equal to an array key withinformElementGroups
.
formEditor.groupSorting¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.groupSorting
- Data type
int
- Needed by
Backend (form editor)
- Mandatory
Recommended
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 groupSorting: 100
- Description
The position within the
formEditor.group
for this form element.
formEditor.iconIdentifier¶
- Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Page.formEditor.iconIdentifier
- Data type
string
- Needed by
Backend (form editor)
- Mandatory
Yes
- Default value (for prototype 'standard')
1Page: 2 formEditor: 3 iconIdentifier: form-page
- Description
An icon identifier which must be registered through the
\TYPO3\CMS\Core\Imaging\IconRegistry
. This icon will be shown withinTree
component."new element" Modal