Index: openacs-4/packages/acs-templating/www/doc/TclDocs/form.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/TclDocs/form.html,v diff -u -r1.2 -r1.2.30.1 --- openacs-4/packages/acs-templating/www/doc/TclDocs/form.html 19 Jan 2002 23:45:46 -0000 1.2 +++ openacs-4/packages/acs-templating/www/doc/TclDocs/form.html 22 Jun 2016 07:48:44 -0000 1.2.30.1 @@ -43,13 +43,13 @@

Method Detail

-

+

* indicates required

-Public Methods:
-
+Public Methods:
+ @@ -60,20 +60,20 @@
- Parameters: + Parameters:
- - - - @@ -85,7 +85,7 @@
id + id * + The form identifier
array_ref + array_ref * + The name of a local array variable whose keys correspond to element identifiers in the form

-
+ @@ -96,19 +96,19 @@
- Parameters: + Parameters:
- -
id + id * + The ID of an ATS form object.
-
Returns: +
Returns:
1 if a form with the specified ID exists. 0 if it does not. @@ -118,7 +118,7 @@

-
+ @@ -129,7 +129,7 @@
-
Returns: +
Returns:
A string containing hidden input tags for inclusion in a form. @@ -139,7 +139,7 @@

-
+ @@ -150,33 +150,33 @@
- Parameters: + Parameters:
- -
id + 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: - - + - - + - - + @@ -188,7 +188,7 @@
method +
method The standard METHOD attribute to specify in the HTML FORM tag at the beginning of the rendered form. Defaults to POST.
html +
html A list of additional name-value attribute pairs to include in the HTML FORM tag at the beginning of the rendered form. Common attributes include JavaScript event handlers and multipart form encoding. For example, { -html { enctype multipart/form-data onSubmit validate() } }
elements +
elements A block of element specifications.

-
+ @@ -199,27 +199,27 @@
- Parameters: + Parameters:
- - - - - - @@ -231,7 +231,7 @@
id + id * + The form identifier
args + args * + A list of element identifiers. Each identifier may be a regexp. For example, form get_combined_values { foo.*} will combine the values of all elements starting with { foo}
return + return * + The combined list of values

-
+ @@ -242,13 +242,13 @@
- Parameters: + Parameters:
- - @@ -260,7 +260,7 @@
id + id * + The form identifier

-
+ @@ -271,19 +271,19 @@
- Parameters: + Parameters:
- -
id + id * + The form identifier
-
Returns: +
Returns:
1 if true or 0 if false @@ -293,7 +293,7 @@

-
+ @@ -304,19 +304,19 @@
- Parameters: + Parameters:
- -
id + id * + The form identifier
-
Returns: +
Returns:
1 if true or 0 if false @@ -326,7 +326,7 @@

-
+ @@ -337,19 +337,19 @@
- Parameters: + Parameters:
- -
id + id * + The form identifier
-
Returns: +
Returns:
1 if true or 0 if false @@ -359,7 +359,7 @@

-
+ @@ -370,20 +370,20 @@
- Parameters: + Parameters:
- - - - @@ -395,7 +395,7 @@
id + id * + The form identifier
args + args * + A list of element identifiers. If the list is empty, retreive all form elements

-
+ @@ -406,20 +406,20 @@
- Parameters: + Parameters:
- - - - @@ -436,8 +436,8 @@

-Private Methods:
-

id + id * + The form identifier.
section + section * + The name of the current section.
+Private Methods:
+ @@ -448,26 +448,26 @@
- Parameters: + Parameters:
- - - -
id + id * + The form identifier
style + style * + The style template to use when generating the form. Form style templates must be placed in the forms subdirectory of the ATS resources directory.
-
Returns: +
Returns:
A string containing a template for the body of the form. @@ -477,7 +477,7 @@

-
+ @@ -494,7 +494,7 @@

-
+ @@ -505,13 +505,13 @@
- Parameters: + Parameters:
- - @@ -523,7 +523,7 @@
id + id * + The form identifier

-
+ @@ -534,26 +534,26 @@
- Parameters: + Parameters:
- - - -
id + id * + The form identifier
tag_attributes + tag_attributes * + A name-value list of special attributes to add to the FORM tag, such as JavaScript event handlers.
-
Returns: +
Returns:
A string containing the rendered tags. @@ -563,7 +563,7 @@

-
+ @@ -574,26 +574,26 @@
- Parameters: + Parameters:
- - - -
id + id * + The form identifier
style + style * + The style template to use when generating the form. Form style templates must be placed in the forms subdirectory of the ATS resources directory.
-
Returns: +
Returns:
A string containing the HTML for the body of the form. @@ -605,7 +605,7 @@

-

+

* indicates required