mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-25 19:48:49 +02:00
97 lines
4.5 KiB
ReStructuredText
97 lines
4.5 KiB
ReStructuredText
.. Copyright (C) 2010-2022 Combodo SARL
|
|
.. http://opensource.org/licenses/AGPL-3.0
|
|
|
|
.. _Form:
|
|
|
|
Form
|
|
====
|
|
|
|
Class Form
|
|
|
|
----
|
|
|
|
.. include:: /manual/Component/Form/FormAdditionalDescription.rst
|
|
|
|
----
|
|
|
|
Twig Tag
|
|
--------
|
|
|
|
:Tag: **UIForm**
|
|
|
|
:Syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIForm Type {Parameters} %}
|
|
Content Goes Here
|
|
{% EndUIForm %}
|
|
|
|
:Type:
|
|
|
|
+--------------------------------+-------------------------+
|
|
| :ref:`Standard <FormStandard>` | @param string|null $sId |
|
|
+--------------------------------+-------------------------+
|
|
|
|
.. _FormStandard:
|
|
|
|
Form Standard
|
|
^^^^^^^^^^^^^
|
|
|
|
:syntax:
|
|
|
|
.. code-block:: twig
|
|
|
|
{% UIForm Standard {sId:'value'} %}
|
|
Content Goes Here
|
|
{% EndUIForm %}
|
|
|
|
:parameters:
|
|
|
|
+-----+--------+----------+------+--+
|
|
| sId | string | optional | NULL | |
|
|
+-----+--------+----------+------+--+
|
|
|
|
Form common parameters
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| Action | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCSSClass | string | CSS class to add to the generated html block |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddCssFileRelPath | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddDeferredBlock | iUIBlock | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddHtml | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddJsFileRelPath | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddMultipleCssFilesRelPaths | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddMultipleJsFilesRelPaths | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| AddSubBlock | iUIBlock | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| DeferredBlocks | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| HasForcedDiv | bool | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| IsHidden | bool | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| OnSubmitJsCode | string | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
| SubBlocks | array | |
|
|
+-----------------------------+----------+------------------------------------------------------------+
|
|
|
|
----
|
|
|
|
.. include:: /manual/Component/Form/FormFooter.rst
|