Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,31 @@ Configuration
.. image:: /_static/images/form-controls/form-control-autofilename-properties.webp
:width: 30%
:alt: Form Control Autofilename Properties
:align: left
:align: center

.. include:: /includes/form-controls/form-control-field-basics.rst
|

+------------------------+-----------------------------------------------------------------------+
|| Properties || None |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || None |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || None |
+------------------------+-----------------------------------------------------------------------+
.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - **Constraints**
-
* - **Related Data Sources**
- None
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,35 @@ Configuration
.. image:: /_static/images/form-controls/form-control-checkbox-properties.webp
:width: 40%
:alt: Form Control Checkbox Properties
:align: left

.. include:: /includes/form-controls/form-control-field-basics.rst

+------------------------+-----------------------------------------------------------------------+
|| Properties || * Read Only: Make field read-only (can't be changed by the author). |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || * Required: Make field required to fill out. |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || None. |
+------------------------+-----------------------------------------------------------------------+
:align: center

|

.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - Read Only
- Make field read-only (can't be changed by the author).
* - **Constraints**
-
* - Required
- Make field required to fill out.
* - **Related Data Sources**
- None
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,53 @@ Configuration
.. image:: /_static/images/form-controls/form-control-date-time-properties.webp
:width: 30%
:alt: Form Control Date-Time Properties
:align: left

.. include:: /includes/form-controls/form-control-field-basics.rst

+------------------------+-----------------------------------------------------------------------+
|| Properties || * Show Date: Display date |
|| || * Show Time: Display time |
|| || * Show Clear Value: Display link to clear value |
|| || * Set Now Link: Display link to set time to now |
|| || * Populated: Put in values in the date/time based on |
|| || populate expression |
|| || * Allow Past Date: Allow user to set date in the past |
|| || * Populate Expression: Populate date/time control using the following|
|| || expressions: now [+ or -][number][days or weeks or years or hours |
|| || or minutes] |
|| || * Use Custom Timezone: Allows user to select a timezone |
|| || * Readonly: Make field read-only (can't be changed by the author). |
|| || * Readonly on Edit: |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || * Required: Make field required to fill out. |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || * None. |
+------------------------+-----------------------------------------------------------------------+
:align: center

|

.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - Show Date
- Display date
* - Show Time
- Display time
* - Show Clear Value
- Display link to clear value
* - Set Now Link
- Display link to set time to now
* - Populated
- Put in values in the date/time based on populate expression
* - Allow Past Date
- Allow user to set date in the past
* - Populate Expression
- Populate date/time control using the following expressions: now [+ or -][number][days or weeks or years or hours or minutes]
* - Use Custom Timezone
- Allows user to select a timezone
* - Readonly
- Make field read-only (can't be changed by the author).
* - Readonly on Edit
-
* - **Constraints**
-
* - Required
- Make field required to fill out.
* - **Related Data Sources**
- None
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,49 @@ Example
:width: 50%
:alt: Form Control Dropdown Example


-------------
Configuration
-------------

.. image:: /_static/images/form-controls/form-control-dropdown.webp
:width: 50%
:alt: Form Control Dropdown Properties
:align: left

.. include:: /includes/form-controls/form-control-field-basics.rst

+------------------------+-----------------------------------------------------------------------+
|| Properties || * Data Source: Source that will populate the dropdown. |
|| || * Allow Empty Value: To enable/disable allowing to leave the field |
|| || empty. |
|| || * Read Only: Make field read-only (can't be changed by the author). |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || * Required: Make field required to fill out. |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || * :ref:`Simple Taxonomy <form-source-simple-taxonomy>` |
|| || * :ref:`Static Key Value Pairs <form-source-kvp>` |
+------------------------+-----------------------------------------------------------------------+
:align: center

|

.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - Data Source
- Source that will populate the dropdown.
* - Allow Empty Value
- To enable/disable allowing to leave the field empty.
* - Read Only
- Make field read-only (can't be changed by the author).
* - **Constraints**
-
* - Required
- Make field required to fill out.
* -
-
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
* - **Related Data Sources**
- * :ref:`Simple Taxonomy <form-source-simple-taxonomy>`
* :ref:`Static Key Value Pairs <form-source-kvp>`
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,37 @@ Configuration
.. image:: /_static/images/form-controls/form-control-filename-properties.webp
:width: 30%
:alt: Form Control Filename Properties
:align: left

.. include:: /includes/form-controls/form-control-field-basics.rst

+------------------------+-----------------------------------------------------------------------+
|| Properties || * Max Length: Maximum number of characters to accept as input. |
|| || * Read Only: Make field read-only (can't be changed by the author). |
|| || * Allow Edit Without Warning. |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || None. |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || None. |
+------------------------+-----------------------------------------------------------------------+
:align: center

|

.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - Max Length
- Maximum number of characters to accept as input.
* - Read Only
- Make field read-only (can't be changed by the author).
* - Allow Edit Without Warning
-
* - **Constraints**
-
* - **Related Data Sources**
- None
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,42 @@ Configuration
.. image:: /_static/images/form-controls/form-control-grouped-checkboxes.webp
:width: 30%
:alt: Form Control Grouped Checkboxes Properties
:align: left

.. include:: /includes/form-controls/form-control-field-basics.rst

+------------------------+-----------------------------------------------------------------------+
|| Properties || * Data Source: Source that will populate the checkboxes. |
|| || * Show Select All: To select/unselect all options. |
|| || * List Direction: Display list horizontally or vertically |
|| || * Read Only: Make field read-only (can't be changed by the author). |
+------------------------+-----------------------------------------------------------------------+
|| Constraints || * Minimum Selection: Set a minimum amount of checkboxes to be |
|| || selected. |
+------------------------+-----------------------------------------------------------------------+
|| Related Data Sources || * :ref:`Simple Taxonomy <form-source-simple-taxonomy>` |
|| || * :ref:`Static Key Value Pairs <form-source-kvp>` |
+------------------------+-----------------------------------------------------------------------+
:align: center

|

.. list-table::
:align: left
:header-rows: 1

* - Name
- Description
* - **Field Basics**
-
* - Title
- Control title to show the author on the input form
* - Name / Variable Name
- Name of variable to store the final result in. This is used by the View layer or the Controllers to gain access to the data during runtime
* - ICE Group
- In-Context Edit Group: During ICE editing in Preview mode, this control will be part of this group for editing which means when the author click on the Pencil Tool, they will get all the controls in the same group associated with the specific Pencil Tool
* - Description
- Form Control description
* - Help
- Help to show authors on the input form associated with this control
* - **Properties**
-
* - Data Source
- Source that will populate the checkboxes.
* - Show Select All
- To select/unselect all options.
* - List Direction
- Display list horizontally or vertically
* - Read Only
- Make field read-only (can't be changed by the author).
* - **Constraints**
-
* - Minimum Selection
- Set a minimum amount of checkboxes to be selected.
* - **Related Data Sources**
- * :ref:`Simple Taxonomy <form-source-simple-taxonomy>`
* :ref:`Static Key Value Pairs <form-source-kvp>`
Loading