Index: openacs-4/packages/acs-templating/www/doc/TclDocs/form.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/TclDocs/form.adp,v diff -u -r1.2.2.1 -r1.2.2.2 --- openacs-4/packages/acs-templating/www/doc/TclDocs/form.adp 25 Aug 2015 18:02:12 -0000 1.2.2.1 +++ openacs-4/packages/acs-templating/www/doc/TclDocs/form.adp 9 Jun 2016 13:03:12 -0000 1.2.2.2 @@ -14,7 +14,7 @@

Method Detail

* indicates required

-Public Methods: +Public Methods:
@@ -23,7 +23,7 @@ onerow data source from database and pass the resulting array reference to set_values for setting default values in an update form.
-Parameters: +Parameters:
@@ -58,7 +58,7 @@
Generates hidden input tags for all values in a form submission. Typically used to create a confirmation page following an initial submission.
-
Returns:
A string containing hidden input tags for inclusion in a +
Returns:
A string containing hidden input tags for inclusion in a form.
@@ -67,14 +67,14 @@
id* @@ -43,12 +43,12 @@
Determine whether a form exists by checking for its data structures.
-Parameters: +Parameters:
id* The ID of an ATS form object.
-
Returns:
1 if a form with the specified ID exists. 0 if it does +
Returns:
1 if a form with the specified ID exists. 0 if it does not.
Initialize the data structures for a form.
-Parameters: +Parameters:
id* A keyword identifier for the form, such as { add_user} or { edit_item} . The ID must be unique in the context of a single page.
-
Options:
+
Options:
methodThe standard METHOD attribute to specify in the HTML FORM tag at the beginning of the rendered form. Defaults to @@ -96,7 +96,7 @@
Return a list which represents the result of getting combined values from multiple form elements
-Parameters: +Parameters:
id* @@ -119,7 +119,7 @@
Return the number of elements in a form
-Parameters: +Parameters:
@@ -132,12 +132,12 @@
Return true if a submission in progress. The submission may or may not be valid.
-Parameters:
id* The form identifier
+Parameters:
id* The form identifier
-
Returns:
1 if true or 0 if false
+
Returns:
1 if true or 0 if false
@@ -148,12 +148,12 @@ to validation problems). This command is used to conditionally set default values for form elements.
-Parameters: +Parameters:
id* The form identifier
-
Returns:
1 if true or 0 if false
+
Returns:
1 if true or 0 if false
@@ -164,12 +164,12 @@ to the next page, as opposed to returning the form back to the user to report validation errors.
-Parameters: +Parameters:
id* The form identifier
-
Returns:
1 if true or 0 if false
+
Returns:
1 if true or 0 if false
@@ -179,7 +179,7 @@ all single values). Typically used when processing the form submission to prepare for DML or other type of transaction.
-Parameters: +Parameters:
id* @@ -201,7 +201,7 @@ Elements are tagged with the current section name as they are added to the form. A form style template may insert a divider in the form whenever the section name changes.
-Parameters: +Parameters:
id* @@ -216,13 +216,13 @@

-Private Methods:
+Private Methods:

Auto-generate the template for a form
-Parameters: +Parameters:
id* @@ -235,7 +235,7 @@ of the ATS resources directory.
-
Returns:
A string containing a template for the body of the form.
+
Returns:
A string containing a template for the body of the form.
@@ -250,7 +250,7 @@ hidden widgets and rendering those that have not been rendered yet. Called after rendering a custom form template as a debugging aid.
-Parameters: +Parameters:
@@ -263,7 +263,7 @@
Render the HTML FORM tag along with a hidden element that identifies the form object.
-Parameters:
id* The form identifier
+Parameters:
id* @@ -275,7 +275,7 @@ the FORM tag, such as JavaScript event handlers.
-
Returns:
A string containing the rendered tags.
+
Returns:
A string containing the rendered tags.
@@ -284,7 +284,7 @@
Render the finished HTML output for a dynamic form.
-Parameters: +Parameters:
id* @@ -297,7 +297,7 @@ of the ATS resources directory.
-
Returns:
A string containing the HTML for the body of the form.
+
Returns:
A string containing the HTML for the body of the form.