Forms
==================

.. py:function:: model.BuildDisplay(name, dd, edit, add, metadata)

    :param str name: The name of the display
    :param DynamicData dd: The DynamicData object containing the data to display
    :param str edit: Optional HTML for edit controls
    :param str add: Optional HTML for add controls
    :param DynamicData metadata: Optional metadata for controlling display formatting
    :return: HTML for a formatted display table
    :rtype: str

    Builds an HTML display table for the provided DynamicData object.

.. py:function:: model.BuildDisplayRows(dd, metadata)

    :param DynamicData dd: The DynamicData object containing the data to display
    :param DynamicData metadata: Optional metadata for controlling display formatting
    :return: HTML for the rows of a display table
    :rtype: str

    Builds the HTML rows for a display table based on the provided DynamicData object.

.. py:function:: model.BuildForm(name, dd, buttons, metadata)

    :param str name: The name of the form
    :param DynamicData dd: The DynamicData object containing the form data
    :param str buttons: Optional HTML for form buttons
    :param DynamicData metadata: Optional metadata for controlling form formatting
    :return: HTML for a formatted form
    :rtype: str

    Builds an HTML form for the provided DynamicData object.

.. py:function:: model.BuildFormRows(dd, metadata)

    :param DynamicData dd: The DynamicData object containing the form data
    :param DynamicData metadata: Optional metadata for controlling form formatting
    :return: HTML for the rows of a form
    :rtype: str

    Builds the HTML rows for a form based on the provided DynamicData object.

.. py:data:: model.Form

    :rtype: string

    Set this to the HTML you wish to display as a form on your page.
    It is loaded into your page by the ``/PyScriptForm/YourScript`` GET request URL.

.. py:data:: model.Header

    :rtype: string

    Set this to the title of your page

.. py:data:: model.HttpMethod

    :return: Either 'get' or 'post'
    :rtype: string

    This readonly property let's you determine action based on whether it is the initial page load (GET)
    or the AJAX call from your Javascript (POST)

.. py:data:: model.Script

    :rtype: string

    Set this to the Javascript you want to run on your page.
    It is loaded into your page by the ``/PyScriptForm/YourScript`` GET request URL.

|
|

+--------------------+------------------+
| **Latest Update**  | **3/28/2025**    |
+--------------------+------------------+