Class FORM

Args:
    components: any components that should be nested in this element
    attributes: any attributes you want to give to this element

Raises:
    SyntaxError: when a stand alone tag receives components

Overrides: object.__init__

(inherited documentation)

EXPERIMENTAL

Sanitize is naive. It should catch any unsafe value for client retrieval.

Perform the .validate() method but returns the form

Usage in controllers:

   # directly on return
   def action():
       #some code here
       return dict(form=FORM(...).process(...))

You can use it with FORM, SQLFORM or FORM based plugins:

   # response.flash messages
   def action():
       form = SQLFORM(db.table).process(message_onsuccess='Sucess!')
       return dict(form=form)

   # callback function
   # callback receives True or False as first arg, and a list of args.
   def my_callback(status, msg):
       response.flash = "Success! "+msg if status else "Errors occured"

   # after argument can be 'flash' to response.flash messages
   # or a function name to use as callback or None to do nothing.
   def action():
       return dict(form=SQLFORM(db.table).process(onsuccess=my_callback)

This function validates the form,
you can use it instead of directly form.accepts.

Usage:
In controller::

    def action():
        form=FORM(INPUT(_name="test", requires=IS_NOT_EMPTY()))
        form.validate() #you can pass some args here - see below
        return dict(form=form)

This can receive a bunch of arguments

onsuccess = 'flash' - will show message_onsuccess in response.flash
            None - will do nothing
            can be a function (lambda form: pass)
onfailure = 'flash' - will show message_onfailure in response.flash
            None - will do nothing
            can be a function (lambda form: pass)
onchange = 'flash' - will show message_onchange in response.flash
            None - will do nothing
            can be a function (lambda form: pass)

message_onsuccess
message_onfailure
message_onchange
next      = where to redirect in case of success
any other kwargs will be passed for form.accepts(...)

generates the xml for this component.

Overrides: XmlComponent.xml