HTMLFormElement
The HTMLFormElement interface represents a <form> element in the DOM; it allows access to and in some cases modification of aspects of the form, as well as access to its component elements.
Properties
This interface also inherits properties from its parent, HTMLElement.
HTMLFormElement.elements읽기 전용-
A
HTMLFormControlsCollection(en-US) holding all form controls belonging to this form element. HTMLFormElement.length(en-US)읽기 전용-
A
longreflecting the number of controls in the form. HTMLFormElement.name(en-US)-
A
DOMStringreflecting the value of the form'snameHTML attribute, containing the name of the form. HTMLFormElement.method(en-US)-
A
DOMStringreflecting the value of the form'smethodHTML attribute, indicating the HTTP method used to submit the form. Only specified values can be set. HTMLFormElement.target(en-US)-
A
DOMStringreflecting the value of the form'stargetHTML attribute, indicating where to display the results received from submitting the form. HTMLFormElement.action(en-US)-
A
DOMStringreflecting the value of the form'sactionHTML attribute, containing the URI of a program that processes the information submitted by the form. HTMLFormElement.encoding(en-US) orHTMLFormElement.enctype(en-US)-
A
DOMStringreflecting the value of the form'senctypeHTML attribute, indicating the type of content that is used to transmit the form to the server. Only specified values can be set. The two properties are synonyms. HTMLFormElement.acceptCharset(en-US)-
A
DOMStringreflecting the value of the form'saccept-charsetHTML attribute, representing the character encoding that the server accepts. HTMLFormElement.autocomplete-
A
DOMStringreflecting the value of the form'sautocompleteHTML attribute, indicating whether the controls in this form can have their values automatically populated by the browser. HTMLFormElement.noValidate-
A
Booleanreflecting the value of the form'snovalidateHTML attribute, indicating whether the form should not be validated.
Named inputs are added to their owner form instance as properties, and can overwrite native properties if they share the same name (eg a form with an input named action will have its action property return that input instead of the form's action HTML attribute).
Methods
This interface also inherits methods from its parent, HTMLElement.
checkValidity()-
Returns
trueif the element's child controls are subject to constraint validation (en-US) and satisfy those contraints; returnsfalseif some controls do not satisfy their constraints. Fires an event namedinvalid (en-US)at any control that does not satisfy its constraints; such controls are considered invalid if the event is not canceled. It is up to the programmer to decide how to respond tofalse. reportValidity()(en-US)-
Returns
trueif the element's child controls satisfy their validation constraints (en-US). Whenfalseis returned, cancelableinvalid (en-US)events are fired for each invalid child and validation problems are reported to the user. requestSubmit()(en-US)-
Requests that the form be submitted using the specified submit button and its corresponding configuration.
reset()(en-US)-
Resets the form to its initial state.
submit()(en-US)-
Submits the form to the server.
Deprecated methods
HTMLFormElement.requestAutocomplete()지원이 중단되었습니다-
Triggers a native browser interface to assist the user in completing the fields which have an autofill field name value that is not
offoron. The form will receive an event once the user has finished with the interface, the event will either beautocompletewhen the fields have been filled orautocompleteerrorwhen there was a problem.
Events
Listen to these events using addEventListener() or by assigning an event listener to the oneventname property of this interface.
formdata-
The
formdataevent fires after the entry list representing the form's data is constructed. Also available via theonformdataproperty. reset-
The
resetevent fires when a form is reset. Also available via theonresetproperty. submit-
The
submitevent fires when a form is submitted. Also available via theonsubmitproperty.
Usage notes
Obtaining a form element object
To obtain an HTMLFormElement object, you can use a CSS selector with querySelector(), or you can get a list of all of the forms in the document using its forms property.
Document.forms returns an array of HTMLFormElement objects listing each of the forms on the page. You can then use any of the following syntaxes to get an individual form:
document.forms[index]-
Returns the form at the specified
indexinto the array of forms. document.forms[id]-
Returns the form whose ID is
id. document.forms[name]-
Returns the form whose
name(en-US) attribute's value isname.
Accessing the form's elements
You can access the list of the form's data-containing elements by examining the form's elements property. This returns an HTMLFormControlsCollection (en-US) listing all of the form's user data entry elements, both those which are descendants of the <form> and those which are made members of the form using their form attributes.
You can also get the form's element by using its name attribute as a key of the form, but using elements is a better approach — it contains only the form's elements, and it cannot be mixed with other attributes of the form.
Elements that are considered form controls
The elements which are included by HTMLFormElement.elements and HTMLFormElement.length are:
<button><fieldset><input>(with the exception that any whosetypeis"image"are omitted for historical reasons)<object><output><select><textarea>
No other elements are included in the list returned by elements, which makes it an excellent way to get at the elements most important when processing forms.
Examples
Creating a new form element, modifying its attributes, then submitting it:
js
var f = document.createElement("form");// Create a form
document.body.appendChild(f); // Add it to the document body
f.action = "/cgi-bin/some.cgi"; // Add action and method attributes
f.method = "POST";
f.submit(); // Call the form's submit method
Extract information from a form element and set some of its attributes:
html
<form name="formA" action="/cgi-bin/test" method="post">
<p>Press "Info" for form details, or "Set" to change those details.</p>
<p>
<button type="button" onclick="getFormInfo();">Info</button>
<button type="button" onclick="setFormInfo(this.form);">Set</button>
<button type="reset">Reset</button>
</p>
<textarea id="form-info" rows="15" cols="20"></textarea>
</form>
<script>
function getFormInfo(){
// Get a reference to the form via its name
var f = document.forms["formA"];
// The form properties we're interested in
var properties = [ 'elements', 'length', 'name', 'charset', 'action', 'acceptCharset', 'action', 'enctype', 'method', 'target' ];
// Iterate over the properties, turning them into a string that we can display to the user
var info = properties.map(function(property) { return property + ": " + f[property] }).join("\n");
// Set the form's <textarea> to display the form's properties
document.forms["formA"].elements['form-info'].value = info; // document.forms["formA"]['form-info'].value would also work
}
function setFormInfo(f){ // Argument should be a form element reference.
f.action = "a-different-url.cgi";
f.name = "a-different-name";
}
</script>
Submit a form into a new window:
html
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>Example new-window form submission</title>
</head>
<body>
<form action="test.php" target="_blank">
<p><label>First name: <input type="text" name="firstname"></label></p>
<p><label>Last name: <input type="text" name="lastname"></label></p>
<p><label><input type="password" name="pwd"></label></p>
<fieldset>
<legend>Pet preference</legend>
<p><label><input type="radio" name="pet" value="cat"> Cat</label></p>
<p><label><input type="radio" name="pet" value="dog"> Dog</label></p>
</fieldset>
<fieldset>
<legend>Owned vehicles</legend>
<p><label><input type="checkbox" name="vehicle" value="Bike">I have a bike</label></p>
<p><label><input type="checkbox" name="vehicle" value="Car">I have a car</label></p>
</fieldset>
<p><button>Submit</button></p>
</form>
</body>
</html>
Submitting forms and uploading files using XMLHttpRequest
If you want to know how to serialize and submit a form using the XMLHttpRequest API, please read this paragraph (en-US).
명세서
| Specification |
|---|
| HTML Standard # htmlformelement |
브라우저 호환성
BCD tables only load in the browser
See also
- The HTML element implementing this interface:
<form>.