dijit/form/Form.js

• Provides:

  • dijit.form.Form

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common
  • dijit.form._FormMixin in common
  • dijit.layout._ContentPaneResizeMixin in common

• dijit.form.Form

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit.form._FormMixin.prototype: (prototype)
    • dijit.layout._ContentPaneResizeMixin.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
    • dijit.form._FormMixin: (call)
    • dijit.layout._ContentPaneResizeMixin: (call)
  • summary

    Widget corresponding to HTML form tag, for validation and serialization

  • example

    	<form dojoType="dijit.form.Form" id="myForm">
    		Name: <input type="text" name="name" />
    	</form>
    	myObj = {name: "John Doe"};
    	dijit.byId('myForm').set('value', myObj);
    
    	myObj=dijit.byId('myForm').get('value');

• dijit.form.Form.name

  • optional
  • type

    String

  • summary

    Name of form for scripting.

• dijit.form.Form.action

  • optional
  • type

    String

  • summary

    Server-side form handler.

• dijit.form.Form.method

  • optional
  • type

    String

  • summary

    HTTP method used to submit the form, either "GET" or "POST".

• dijit.form.Form.encType

  • optional
  • type

    String

  • summary

    Encoding type for the form, ex: application/x-www-form-urlencoded.

• dijit.form.Form.accept-charset

  • optional
  • type

    String

  • summary

    List of supported charsets.

• dijit.form.Form.accept

  • optional
  • type

    String

  • summary

    List of MIME types for file upload.

• dijit.form.Form.target

  • optional
  • type

    String

  • summary

    Target frame for the document to be opened in.

• dijit.form.Form.templateString

  • type

    String

• dijit.form.Form.attributeMap

  • type

    Object

• dijit.form.Form.postMixInProperties

  • type

    Function

• dijit.form.Form.nameAttrSetting

• dijit.form.Form.execute

  • parameters:
    • formContents: (typeof Object)
  • summary

    Deprecated: use submit()

  • tags:
  • type

    Function

• dijit.form.Form.onExecute

  • summary

    Deprecated: use onSubmit()

  • tags:
  • type

    Function

• dijit.form.Form._setEncTypeAttr

  • parameters:
    • value: (typeof String)
  • type

    Function

• dijit.form.Form.domNode.encoding

• dijit.form.Form.postCreate

  • type

    Function

• dijit.form.Form.reset

  • parameters:
    • e: (typeof Event)
  • summary

    restores all widget values back to their init values,
    calls onReset() which can cancel the reset by returning false

  • type

    Function

• dijit.form.Form.onReset

  • parameters:
    • e: (typeof Event)
  • returns

    Boolean

  • summary

    Callback when user resets the form. This method is intended
    to be over-ridden. When the <code>reset</code> method is called
    programmatically, the return value from <code>onReset</code> is used
    to compute whether or not resetting should proceed

  • tags: callback
  • type

    Function

• dijit.form.Form._onReset

  • parameters:
    • e
  • type

    Function

• dijit.form.Form._onSubmit

  • parameters:
    • e
  • type

    Function

• dijit.form.Form.onSubmit

  • parameters:
    • e: (typeof Event)
  • returns

    Boolean

  • summary

    Callback when user submits the form.

  • description

    This method is intended to be over-ridden, but by default it checks and
    returns the validity of form elements. When the `submit`
    method is called programmatically, the return value from
    `onSubmit` is used to compute whether or not submission
    should proceed

  • tags: extension
  • type

    Function

• dijit.form.Form.submit

  • summary

    programmatically submit form if and only if the <code>onSubmit</code> returns true

  • type

    Function

• dijit.form

  • type

    Object

• dijit

  • type

    Object