HTMLFormElement Class
Contents
[
Hide
]HTMLFormElement class
The FORM element encompasses behavior similar to a collection and an element. It provides direct access to the contained form controls as well as the attributes of the form element. See the FORM element definition in HTML 4.01.
See also the Document object Model (DOM) Level 2 HTML Specification.
public class HTMLFormElement : HTMLElement, IHTMLFormElement
Properties
| Name | Description |
|---|---|
| [getAcceptCharset] | |
| [setAcceptCharset] List of character sets supported by the server. See the accept-charset attribute definition in HTML 4.01. | |
| [getAction] | |
| [setAction] Server-side form handler. See the action attribute definition in HTML 4.01. | |
| getAttributes A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. | |
| getBaseURI The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node. | |
| getChildElementCount Returns the current number of element nodes that are children of this element. 0 if this element has no child nodes that are of nodeType 1. | |
getChildNodes The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments. | |
| getChildren Returns the child elements of current element. | |
| getClassList Returns a live DOMTokenList which contains tokens received from parsing the “class” attribute. | |
| [getClassName] | |
| [setClassName] The class attribute of the element. This attribute has been renamed due to conflicts with the “class” keyword exposed by many languages. See the class attribute definition in HTML 4.01. | |
| [getDir] | |
| [setDir] Specifies the base direction of directionally neutral text and the directionality of tables. See the dir attribute definition in HTML 4.01. | |
| getElements Returns a collection of all form control elements in the form. | |
| [getEnctype] | |
| [setEnctype] The content type of the submitted form, generally “application/x-www-form-urlencoded”. See the enctype attribute definition in HTML 4.01. The onsubmit even handler is not guaranteed to be triggered when invoking this method. The behavior is inconsistent for historical reasons and authors should not rely on a particular one. | |
getFirstChild The read-only firstChild property of the Node interface returns the node’s first child in the tree, or null if the node has no children. | |
| getFirstElementChild Returns the first child element node of this element. null if this element has no child elements. | |
| [getId] | |
| [setId] The element’s identifier. See the id attribute definition in HTML 4.01. | |
| [getInnerHTML] | |
| [setInnerHTML] Returns a fragment of HTML or XML that represents the element’s contents. Can be set, to replace the contents of the element with nodes parsed from the given String. | |
| [getLang] | |
| [setLang] Language code defined in RFC 1766. See the lang attribute definition in HTML 4.01. | |
getLastChild The read-only lastChild property of the Node interface returns the last child of the node. If its parent is an element, then the child is generally an element node, a text node, or a comment node. It returns null if there are no child elements | |
| getLastElementChild Returns the last child element node of this element. null if this element has no child elements. | |
| getLength The number of form controls in the form. | |
| getLocalName Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null. | |
| [getMethod] | |
| [setMethod] HTTP method [IETF RFC 2616] used to submit form. See the method attribute definition in HTML 4.01. | |
| [getName] | |
| [setName] Names the form. | |
| getNamespaceURI The package URI of this node, or null if it is unspecified. | |
| getNextElementSibling Returns the next sibling element node of this element. null if this element has no element sibling nodes that come after this one in the document tree. | |
getNextSibling The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent’s childNodes, or returns null if the specified node is the last child in the parent element. | |
| getNodeName The name of this node, depending on its type. | |
| getNodeType A code representing the type of the underlying object. | |
| [getNodeValue] | |
[setNodeValue] The nodeValue property of the Node interface returns or sets the value of the current node. | |
| [getOuterHTML] | |
| [setOuterHTML] Returns a fragment of HTML or XML that represents the element and its contents. Can be set, to replace the element with nodes parsed from the given String. | |
| getOwnerDocument The read-only ownerDocument property of the Node interface returns the top-level document object of the node. | |
getParentElement The read-only parentElement property of Node interface returns the DOM node’s parent Element, or null if the node either has no parent, or its parent isn’t a DOM Element. | |
| getParentNode The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree. | |
| getPrefix The package prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect | |
| getPreviousElementSibling Returns the previous sibling element node of this element. null if this element has no element sibling nodes that come before this one in the document tree. | |
getPreviousSibling The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent’s childNodes list, or null if the specified node is the first in that list. | |
| getSchemaTypeInfo The type information associated with this element. | |
| getShadowRoot Returns shadowRoot stored on this element or null if it’s closed. | |
| getStyle Represents a style attribute that allows author to directly apply style information to specific element. | |
| getTagName The name of the element. | |
| [getTarget] | |
| [setTarget] Frame to render the resource in. See the target attribute definition in HTML 4.01. | |
| [getTextContent] | |
| [setTextContent] This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new String is not empty or null, replaced by a single Text node containing the String this attribute is set to. | |
| [getTitle] | |
| [setTitle] The element’s advisory title. See the title attribute definition in HTML 4.01. |
Methods
| Name | Description |
|---|---|
| addEventListener(String, IEventListener) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, DOMEventHandler, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, IEventListener, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| appendChild(Node) | The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, appendChild() moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node). |
| attachShadow(ShadowRootMode) | Creates shadow root and attaches it to current element. |
| cloneNode() | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| cloneNode(bool) | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| dispatchEvent(Event) | Dispatches an Event at the specified EventTarget, (synchronously) invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent(). |
| dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| getAttribute(String) | Retrieves an attribute value by name. |
| getAttributeNode(String) | Retrieves an attribute node by name. |
| getAttributeNodeNS(String, String) | Retrieves an Attr node by local name and package URI. |
| getAttributeNS(String, String) | Retrieves an attribute value by local name and package URI. |
| getElementsByClassName(String) | Returns HTMLCollection object containing all the elements within element that have all the classes specified in argument. |
| getElementsByTagName(String) | Returns HTMLCollection object containing all elements with a given tag name, in document order. |
| getElementsByTagNameNS(String, String) | Returns HTMLCollection object containing all elements with a given local name and package URI String in document order. |
| getPlatformType() | This method is used to retrieve the ECMAScript object . |
| hasAttribute(String) | Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
| hasAttributeNS(String, String) | Returns true when an attribute with a given local name and package URI is specified on this element or has a default value, false otherwise. |
| hasAttributes() | Returns whether this node (if it is an element) has any attributes |
| hasChildNodes() | The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not. |
| insertBefore(Node, Node) | The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node. |
| isDefaultNamespace(String) | The isDefaultNamespace() method of the Node interface accepts a package URI as an argument. It returns a boolean value that is true if the package is the default package on the given node and false if not. |
| isEqualNode(Node) | The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes. |
| isSameNode(Node) | The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object). |
| lookupNamespaceURI(String) | The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the package URI associated with it on the given node if found (and null if not). |
| lookupPrefix(String) | The lookupPrefix() method of the Node interface returns a String containing the prefix for a given package URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned. |
| normalize() | Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a “normal” form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter “normalize-characters” of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes. |
| querySelector(String) | Returns the first Element in document, which match selector |
| querySelectorAll(String) | Returns a NodeList of all the Elements in document, which match selector |
| remove() | Removes this instance. |
| removeAttribute(String) | Removes an attribute by name. |
| removeAttributeNode(Attr) | Removes the specified attribute node. |
| removeAttributeNS(String, String) | Removes an attribute by local name and package URI. |
| removeChild(Node) | The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node. |
| removeEventListener(String, IEventListener) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, DOMEventHandler, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, IEventListener, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| replaceChild(Node, Node) | Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. |
| reset() | Restores a form element’s default values. It performs the same action as a reset button. |
| setAttribute(String, String) | Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter |
| setAttributeNode(Attr) | Adds a new attribute node. If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one. |
| setAttributeNodeNS(Attr) | Adds a new attribute. If an attribute with that local name and that package URI is already present in the element, it is replaced by the new one. |
| setAttributeNS(String, String, String) | Adds a new attribute. If an attribute with the same local name and package URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. |
| setIdAttribute(String, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| setIdAttributeNode(Attr, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| setIdAttributeNS(String, String, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| submit() | Submits the form. It performs the same action as a submit button. |
| toString() | Returns a String that represents this instance. |
Events
| Name | Description |
|---|---|
| event OnAbort | Gets or sets event handler for OnAbort event. |
| event OnBlur | Gets or sets event handler for OnBlur event. |
| event OnCancel | Gets or sets event handler for OnCancel event. |
| event OnCanplay | Gets or sets event handler for OnCanplay event. |
| event OnCanPlayThrough | Gets or sets event handler for OnCanPlayThrough event. |
| event OnChange | Gets or sets event handler for OnChange event. |
| event OnClick | Gets or sets event handler for OnClick event. |
| event OnCueChange | Gets or sets event handler for OnCueChange event. |
| event OnDblClick | Gets or sets event handler for OnDblClick event. |
| event OnDurationChange | Gets or sets event handler for OnDurationChange event. |
| event OnEmptied | Gets or sets event handler for OnEmptied event. |
| event OnEnded | Gets or sets event handler for OnEnded event. |
| event OnError | Gets or sets event handler for OnError event. |
| event OnFocus | Gets or sets event handler for OnFocus event. |
| event OnInput | Gets or sets event handler for OnInput event. |
| event OnInvalid | Gets or sets event handler for OnInvalid event. |
| event OnKeyDown | Gets or sets event handler for OnKeyDown event. |
| event OnKeyPress | Gets or sets event handler for OnKeyPress event. |
| event OnKeyUp | Gets or sets event handler for OnKeyUp event. |
| event OnLoad | Gets or sets event handler for OnLoad event. |
| event OnLoadedData | Gets or sets event handler for OnLoadedData event. |
| event OnLoadedMetadata | Gets or sets event handler for OnLoadedMetadata event. |
| event OnLoadStart | Gets or sets event handler for OnLoadStart event. |
| event OnMouseDown | Gets or sets event handler for OnMouseDown event. |
| event OnMouseEnter | Gets or sets event handler for OnMouseEnter event. |
| event OnMouseLeave | Gets or sets event handler for OnMouseLeave event. |
| event OnMouseMove | Gets or sets event handler for OnMouseMove event. |
| event OnMouseOut | Gets or sets event handler for OnMouseOut event. |
| event OnMouseOver | Gets or sets event handler for OnMouseOver event. |
| event OnMouseUp | Gets or sets event handler for OnMouseUp event. |
| event OnMouseWheel | Gets or sets event handler for OnMouseWheel event. |
| event OnPause | Gets or sets event handler for OnPause event. |
| event OnPlay | Gets or sets event handler for OnPlay event. |
| event OnPlaying | Gets or sets event handler for OnPlaying event. |
| event OnProgress | Gets or sets event handler for OnProgress event. |
| event OnRateChange | Gets or sets event handler for OnRateChange event. |
| event OnReset | Gets or sets event handler for OnReset event. |
| event OnResize | Gets or sets event handler for OnResize event. |
| event OnScroll | Gets or sets event handler for OnScroll event. |
| event OnSeeked | Gets or sets event handler for OnSeeked event. |
| event OnSeeking | Gets or sets event handler for OnSeeking event. |
| event OnSelect | Gets or sets event handler for OnSelect event. |
| event OnShow | Gets or sets event handler for OnShow event. |
| event OnStalled | Gets or sets event handler for OnStalled event. |
| event OnSubmit | Gets or sets event handler for OnSubmit event. |
| event OnSuspend | Gets or sets event handler for OnSuspend event. |
| event OnTimeUpdate | Gets or sets event handler for OnTimeUpdate event. |
| event OnToggle | Gets or sets event handler for OnToggle event. |
| event OnVolumeChange | Gets or sets event handler for OnVolumeChange event. |
| event OnWaiting | Gets or sets event handler for OnWaiting event. |
See Also
- class HTMLElement
- interface IHTMLFormElement
- package com.aspose.html
- package Aspose.HTML