onsubmit event

Article
01/24/2012

[This documentation is preliminary and is subject to change.]

Fires when a FORM is about to be submitted.

Syntax

HTML Attribute	<element onsubmit = "handler(event)">
Event Property	object.onsubmit = handler;
attachEvent Method	object.attachEvent("onsubmit", handler)
addEventListener Method	object.addEventListener("submit", handler, useCapture)

Standards information

HTML 4.01 Specification, Section 18.2.3

Event information

Synchronous	No
Bubbles	No
Cancelable	No

Event handler parameters

pEvtObj [in]
Type: IHTMLEventObj

Remarks

You can override this event by returning false in the event handler. Use this capability to validate data on the client side to prevent invalid data from being submitted to the server. If the event handler is called by the onsubmit attribute of the form object, the code must explicitly request the return value using the return function, and the event handler must provide an explicit return value for each possible code path in the event handler function.

The submit method does not invoke the onsubmit event handler.

Causes a form to be sent to whatever location is stipulated in the ACTION attribute of the form object.

To invoke this event, do one of the following:

Submit a form using the INPUT TYPE=submit, INPUT TYPE=image, or BUTTON TYPE=submit object.

The pEvtObj parameter is required for the following interfaces: