HTMLKeygenElement
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Note: This page describes the Keygen Element interface as specified, not as currently implemented by Gecko. See bug 101019 for details and status.
The <keygen>
elements expose the HTMLKeygenElement
interface, which provides special properties and methods (beyond the regular element
object interface they also have available to them by inheritance) for manipulating the layout and presentation of keygen
elements.
Properties
- autofocus
-
Is a
Boolean
that reflects theautofocus
HTML attribute, indicating that the form control should have input focus when the page loads. - challenge
-
Is a
DOMString
that reflects thechallenge
HTML attribute, containing a challenge string that is packaged with the submitted key. - form Read only
-
Is a
HTMLFormElement
that indicates the control's form owner, reflecting theform
HTML attribute if it is defined. - keytype
-
Is a
DOMString
that reflects thekeytype
HTML attribute, containing the type of key used. - labels Read only Unimplemented (see bug 556743)
-
Is a
NodeList
that represents a list of label elements associated with this keygen element. - name
-
Is a
DOMString
that reflects thename
HTML attribute, containing the name for the control that is submitted with form data. - type Read only
-
Is a
DOMString
that must be the valuekeygen
. - validationMessage Read only
-
Is a
DOMString
representing a localized message that describes the validation constraints that the control does not satisfy (if any). This is the empty string if the control is not a candidate for constraint validation (willValidate
is false), or it satisfies its constraints. - validity Read only
-
Is a
ValidityState
representing the validity states that this element is in. - willValidate
-
Is a
Boolean
that is always false becausekeygen
objects are never candidates for constraint validation.
Methods
Name & Arguments | Return | Description |
---|---|---|
checkValidity() |
Boolean |
Always returns true because keygen objects are never
candidates for constraint validation.
|
setCustomValidity(in DOMString error) |
void |
Sets a custom validity message for the element. If this message is not the empty string, then the element is suffering from a custom validity error, and does not validate. |
Browser compatibility
BCD tables only load in the browser