HTMLButtonElement
The HTMLButtonElement
interface provides properties and methods (beyond the regular HTMLElement
interface it also has available to it by inheritance) for manipulating <button>
elements.
Properties
Inherits properties from its parent, HTMLElement
.
HTMLButtonElement.accessKey
- Is a
DOMString
indicating the single-character keyboard key to give access to the button. HTMLButtonElement.autofocus
- Is a
Boolean
indicating whether or not the control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form-associated element in a document can have this attribute specified. HTMLButtonElement.disabled
- Is a
Boolean
indicating whether or not the control is disabled, meaning that it does not accept any clicks. HTMLButtonElement.form
Read only- Is a
HTMLFormElement
reflecting the form that this button is associated with. If the button is a descendant of a form element, then this attribute is the ID of that form element.
If the button is not a descendant of a form element, then the attribute can be the ID of any form element in the same document it is related to, or thenull
value if none matches. HTMLButtonElement.formAction
- Is a
DOMString
reflecting the URI of a resource that processes information submitted by the button. If specified, this attribute overrides theaction
attribute of the<form>
element that owns this element. HTMLButtonElement.formEnctype
- Is a
DOMString
reflecting the type of content that is used to submit the form to the server. If specified, this attribute overrides theenctype
attribute of the<form>
element that owns this element. HTMLButtonElement.formMethod
- Is a
DOMString
reflecting the HTTP method that the browser uses to submit the form. If specified, this attribute overrides themethod
attribute of the<form>
element that owns this element. HTMLButtonElement.formNoValidate
- Is a
Boolean
indicating that the form is not to be validated when it is submitted. If specified, this attribute overrides thenovalidate
attribute of the<form>
element that owns this element. HTMLButtonElement.formTarget
- Is a
DOMString
reflecting a name or keyword indicating where to display the response that is received after submitting the form. If specified, this attribute overrides thetarget
attribute of the<form>
element that owns this element. HTMLButtonElement.labels
Read only- Is a
NodeList
that represents a list of<label>
elements that are labels for this button. HTMLButtonElement.menu
- Is a
HTMLMenuElement
representing the menu element to be displayed if the button is clicked and is oftype="menu"
. HTMLButtonElement.name
- Is a
DOMString
representing the name of the object when submitted with a form. If specified, it must not be the empty string. HTMLButtonElement.tabIndex
- Is a
long
that represents this element's position in the tabbing order. HTMLButtonElement.type
- Is a
DOMString
indicating the behavior of the button. This is an enumerated attribute with the following possible values:submit
: The button submits the form. This is the default value if the attribute is not specified, or if it is dynamically changed to an empty or invalid value.reset
: The button resets the form.button
: The button does nothing.menu
: The button displays a menu.
HTMLButtonElement.willValidate
Read only- Is a
Boolean
indicating whether the button is a candidate for constraint validation. It isfalse
if any conditions bar it from constraint validation, including: itstype
property isreset
orbutton
; it has a<datalist>
ancestor; or thedisabled
property is set totrue
. HTMLButtonElement.validationMessage
Read only- Is a
DOMString
representing the localized message that describes the validation constraints that the control does not satisfy (if any). This attribute is the empty string if the control is not a candidate for constraint validation (willValidate
isfalse
), or it satisfies its constraints. HTMLButtonElement.validity
Read only- Is a
ValidityState
representing the validity states that this button is in. HTMLButtonElement.value
- Is a
DOMString
representing the current form control value of the button.
Methods
Inherits methods from its parent, HTMLElement
Name | Return Type | Description |
---|---|---|
checkValidity() |
Boolean |
Not supported for reset or button elements. |
reportValidity() |
Boolean |
Not supported for reset or button elements. |
setCustomValidity(in DOMString error) |
void |
Not supported for reset or button elements. |
With Gecko-based browser, use the :-moz-submit-invalid
pseudo-class to style submit buttons based on the validation of a form.
Specifications
Specification | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'HTMLButtonElement' in that specification. |
Living Standard | |
HTML 5.2 The definition of 'HTMLButtonElement' in that specification. |
Recommendation | The menu attribute and type="menu" value have been removed. |
HTML 5.1 The definition of 'HTMLButtonElement' in that specification. |
Recommendation | The following attribute has been added: menu .The type attribute can take one more value, "menu ". |
HTML5 The definition of 'HTMLButtonElement' in that specification. |
Recommendation | The attributes tabindex and accesskey , are now defined on HTMLElement .The following attributes have been added: autofocus , formAction , formEnctype , formMethod , formNoValidate , formTarget , labels , validity , validationMessage , and willValidate .The following methods have been added: checkValidity() , setCustomValidity() .The type attribute is no more read-only. |
Document Object Model (DOM) Level 2 HTML Specification The definition of 'HTMLButtonElement' in that specification. |
Obsolete | No change from Document Object Model (DOM) Level 1 Specification. |
Document Object Model (DOM) Level 1 Specification The definition of 'HTMLButtonElement' in that specification. |
Obsolete | Initial definition. |
Browser compatibility
BCD tables only load in the browser
See also
- HTML element implementing this interface:
<button>