.. include:: /Includes.rst.txt

.. _LegacyTypoScriptReference:

Reference
---------

Part of the :ref:`legacy TypoScript rendering path <LegacyTypoScriptRendering>`,
deprecated and not recommended for new projects, see
:ref:`RenderingArchitecture`. Retained for existing projects; new
projects should use the :ref:`DataProcessingReference` instead.

.. ### BEGIN~OF~TABLE ###


.. _typoscript-cobject-reference:

TypoScript
^^^^^^^^^^


.. _typoscript-setup:

setup
"""""

.. container:: table-row

   Property
         setup

   Data type
         Internal /stdWrap

   Description
         The setup handed over to the userFunc that is responsible for the
         rendering process

   Default
         N/A


.. _typoscript-setup-default:

setup.default
"""""""""""""

.. container:: table-row

   Property
         setup.default

   Data type
         Internal / stdWrap

   Description
         The default setup used by any Grid Element layout that has not got its
         own setup available. Layouts are assigned by their layout identifier:
         for a database-backed CE backend layout record this is an explicitly
         configured alias where one exists, or the record's UID otherwise; a
         TSconfig-defined layout has its own identifier, see :ref:`TSconfig`.

         It usually contains the columns parameter and might use additional
         stdWrap methods. If you provide a cObject as stdWrap method, this will
         override the default output and give you the option to make use of the
         special virtual fields containing prerendered content.

   Default
         N/A


.. _typoscript-setup-123:

setup.123
"""""""""

.. container:: table-row

   Property
         setup.123

   Data type
         Internal / stdWrap

   Description
         This setup will be used for the Grid Element layout with the layout
         identifier 123, an alias or, absent one, a UID for a database-backed
         layout, or a TSconfig-defined layout's own identifier

   Default
         N/A


.. _typoscript-columns:

columns
"""""""

.. container:: table-row

   Property
         columns

   Data type
         Internal / stdWrap

   Description
         This contains the setup for the default column and any other column
         that might differ from the default. Columns are assigned by their
         column value.

   Default
         N/A


.. _typoscript-columns-default:

columns.default
"""""""""""""""

.. container:: table-row

   Property
         columns.default

   Data type
         Internal / stdWrap

   Description
         This will be the setup used for any column that has not got its own
         setup available

   Default
         N/A


.. _typoscript-columns-123:

columns.123
"""""""""""

.. container:: table-row

   Property
         columns.123

   Data type
         Internal / stdWrap

   Description
         This will be used for the column with the column value 123

   Default
         N/A


.. _typoscript-renderObj:

renderObj
"""""""""

.. container:: table-row

   Property
         renderObj

   Data type
         cObject / stdWrap

   Description
         Can be any kind of TypoScript content object, like TEXT or TEMPLATE

   Default
         COA


.. _typoscript-flexform-fieldname:

flexform\_fieldname
"""""""""""""""""""

.. container:: table-row

   Property
         flexform\_fieldname

   Data type
         Flexform field

   Description
         Get the value of a field defined in the flexform of the grid layout of
         the current cObj

   Default
         N/A


.. _typoscript-parentgrid-fieldname:

parentgrid\_fieldname
"""""""""""""""""""""

.. container:: table-row

   Property
         parentgrid\_fieldname

   Data type
         Value of the parent container

   Description
         Get the value of a field of the parent container of the current cObj

   Default
         N/A


.. _typoscript-tx-gridelements-view-children:

tx\_gridelements\_view\_children
""""""""""""""""""""""""""""""""

.. container:: table-row

   Property
         tx\_gridelements\_view\_children

   Data type
         Array

   Description
         An array containing all the children as raw data

   Default
         N/A

.. _typoscript-tx-gridelements-view-columns:

tx\_gridelements\_view\_columns
"""""""""""""""""""""""""""""""

.. container:: table-row

   Property
         tx\_gridelements\_view\_columns

   Data type
         Array

   Description
         An array containing the prerendered columns

   Default
         N/A


.. _typoscript-tx-gridelements-view-column-123:

tx\_gridelements\_view\_column\_123
"""""""""""""""""""""""""""""""""""

.. container:: table-row

   Property
         tx\_gridelements\_view\_column\_123

   Data type
         HTML

   Description
         The prerendered content of column 123

   Default
         N/A


.. _typoscript-tx-gridelements-view-child-123:

tx\_gridelements\_view\_child\_123
""""""""""""""""""""""""""""""""""

.. container:: table-row

   Property
         tx\_gridelements\_view\_child\_123

   Data type
         HTML

   Description
         The prerendered child with the uid 123

   Default
         N/A


.. ###### END~OF~TABLE ######