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.

Inheritance Hierarchy

Namespace: Aspose.Html
Assembly: Aspose.HTML (in Aspose.HTML.dll) Version: 21.11
Syntax
public class HTMLFormElement : HTMLElement, 
	IHTMLFormElement

The HTMLFormElement type exposes the following members.

Properties
  NameDescription
Public propertyAcceptCharset
List of character sets supported by the server. See the accept-charset attribute definition in HTML 4.01.
Public propertyAction
Server-side form handler. See the action attribute definition in HTML 4.01.
Public propertyAttributes
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
(Inherited from Element.)
Public propertyBaseURI

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

The base URL is used to resolve relative URLs when the browser needs to obtain an absolute URL, for example when processing the HTML img element's src attribute or the xlink:href or href attributes in SVG.

(Inherited from Node.)
Public propertyChildElementCount
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.
(Inherited from Element.)
Public propertyChildNodes

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.

Note: The NodeList being live means that its content is changed each time new children are added or removed.
(Inherited from Node.)
Public propertyChildren
Returns the child elements of current element.
(Inherited from Element.)
Public propertyClassList
Returns a live DOMTokenList which contains tokens received from parsing the "class" attribute.
(Inherited from Element.)
Public propertyClassName
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.
(Inherited from HTMLElement.)
Public propertyDir
Specifies the base direction of directionally neutral text and the directionality of tables. See the dir attribute definition in HTML 4.01.
(Inherited from HTMLElement.)
Public propertyElements
Returns a collection of all form control elements in the form.
Public propertyEnctype
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.
Public propertyFirstChild

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.

If the node is a Document, this property returns the first node in the list of its direct children.

(Inherited from Node.)
Public propertyFirstElementChild
Returns the first child element node of this element. null if this element has no child elements.
(Inherited from Element.)
Public propertyId
The element's identifier. See the id attribute definition in HTML 4.01.
(Inherited from HTMLElement.)
Public propertyInnerHTML
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.
(Inherited from Element.)
Public propertyLang
Language code defined in RFC 1766. See the lang attribute definition in HTML 4.01.
(Inherited from HTMLElement.)
Public propertyLastChild

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

(Inherited from Node.)
Public propertyLastElementChild
Returns the last child element node of this element. null if this element has no child elements.
(Inherited from Element.)
Public propertyLength
The number of form controls in the form.
Public propertyLocalName
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.
(Inherited from Element.)
Public propertyMethod
HTTP method [IETF RFC 2616] used to submit form. See the method attribute definition in HTML 4.01.
Public propertyName
Names the form.
Public propertyNamespaceURI
The namespace URI of this node, or null if it is unspecified.
(Inherited from Element.)
Public propertyNextElementSibling
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.
(Inherited from Element.)
Public propertyNextSibling

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.

(Inherited from Node.)
Public propertyNodeName
The name of this node, depending on its type.
(Inherited from Element.)
Public propertyNodeType
A code representing the type of the underlying object.
(Inherited from Element.)
Public propertyNodeValue

The nodeValue property of the Node interface returns or sets the value of the current node.

(Inherited from Node.)
Public propertyOuterHTML
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.
(Inherited from Element.)
Public propertyOwnerDocument

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

(Inherited from Node.)
Public propertyParentElement

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.

(Inherited from Node.)
Public propertyParentNode

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

Document and DocumentFragment nodes can never have a parent, so parentNode will always return null. It also returns null if the node has just been created and is not yet attached to the tree.

(Inherited from Node.)
Public propertyPrefix
The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect
(Inherited from Element.)
Public propertyPreviousElementSibling
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.
(Inherited from Element.)
Public propertyPreviousSibling

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.

(Inherited from Node.)
Public propertySchemaTypeInfo
The type information associated with this element.
(Inherited from Element.)
Public propertyShadowRoot
Returns shadowRoot stored on this element or null if it's closed.
(Inherited from Element.)
Public propertyStyle
Represents a style attribute that allows author to directly apply style information to specific element.
(Inherited from HTMLElement.)
Public propertyTagName
The name of the element.
(Inherited from Element.)
Public propertyTarget
Frame to render the resource in. See the target attribute definition in HTML 4.01.
Public propertyTextContent
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.
(Inherited from Element.)
Public propertyTitle
The element's advisory title. See the title attribute definition in HTML 4.01.
(Inherited from HTMLElement.)
Methods
  NameDescription
Public methodAddEventListener(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.

It works by adding a function, or an object that implements EventListener, to the list of event listeners for the specified event type on the EventTarget on which it's called. If the function or object, is already in the list of event listeners for this target, they are not added a second time.

(Inherited from EventTarget.)
Public methodAddEventListener(String, DOMEventHandler, Boolean)

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

It works by adding a function, or an object that implements EventListener, to the list of event listeners for the specified event type on the EventTarget on which it's called. If the function or object, is already in the list of event listeners for this target, they are not added a second time.

(Inherited from EventTarget.)
Public methodAddEventListener(String, IEventListener, Boolean)

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

It works by adding a function, or an object that implements EventListener, to the list of event listeners for the specified event type on the EventTarget on which it's called. If the function or object, is already in the list of event listeners for this target, they are not added a second time.

(Inherited from EventTarget.)
Public methodAppendChild

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).

This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The Node.cloneNode() method can be used to make a copy of the node before appending it under the new parent. Copies made with cloneNode are not be automatically kept in sync.

(Inherited from Node.)
Public methodAttachShadow
Creates shadow root and attaches it to current element.
(Inherited from Element.)
Public methodCloneNode

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.

Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using addEventListener() or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a <canvas> element, the painted image is not copied.

(Inherited from Node.)
Public methodCloneNode(Boolean)

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.

Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using addEventListener() or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a <canvas> element, the painted image is not copied.

(Inherited from Node.)
Public methodDispatchEvent

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().

(Inherited from EventTarget.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from EventTarget.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
(Inherited from Element.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Finalizes an instance of the Node class.
(Inherited from Node.)
Public methodGetAttribute
Retrieves an attribute value by name.
(Inherited from Element.)
Public methodGetAttributeNode
Retrieves an attribute node by name.
(Inherited from Element.)
Public methodGetAttributeNodeNS
Retrieves an Attr node by local name and namespace URI.
(Inherited from Element.)
Public methodGetAttributeNS
Retrieves an attribute value by local name and namespace URI.
(Inherited from Element.)
Public methodGetElementsByClassName
Returns a live NodeList object containing all the elements in the document that have all the classes specified in argument. http://www.w3.org/TR/dom/
(Inherited from Element.)
Public methodGetElementsByTagName
Returns a NodeList of all descendant Elements with a given tag name, in document order.
(Inherited from Element.)
Public methodGetElementsByTagNameNS
Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.
(Inherited from Element.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetPlatformType

This method is used to retrieve the ECMAScript object .

(Inherited from DOMObject.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodHasAttribute
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
(Inherited from Element.)
Public methodHasAttributeNS
Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
(Inherited from Element.)
Public methodHasAttributes
Returns whether this node (if it is an element) has any attributes
(Inherited from Element.)
Public methodHasChildNodes

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

(Inherited from Node.)
Public methodInsertBefore

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

If the given node already exists in the document, insertBefore() moves it from its current position to the new position. (That is, it will automatically be removed from its existing parent before appending it to the specified new parent.)

This means that a node cannot be in two locations of the document simultaneously.

(Inherited from Node.)
Public methodIsDefaultNamespace

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not.

Note: The default namespace of an HTML element is always "". For a SVG element, it is set by the xmlns attribute.
(Inherited from Node.)
Public methodIsEqualNode

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.

(Inherited from Node.)
Public methodIsSameNode

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).

Note: There is no need to use isSameNode(); instead use the === strict equality operator.
(Inherited from Node.)
Public methodLookupNamespaceURI

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not).

(Inherited from Node.)
Public methodLookupPrefix

The lookupPrefix() method of the Node interface returns a String containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.

(Inherited from Node.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNormalize

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.

(Inherited from Node.)
Public methodQuerySelector
Returns the first Element in document, which match selector
(Inherited from Element.)
Public methodQuerySelectorAll
Returns a NodeList of all the Elements in document, which match selector
(Inherited from Element.)
Public methodRemove
Removes this instance.
(Inherited from Element.)
Public methodRemoveAttribute
Removes an attribute by name.
(Inherited from Element.)
Public methodRemoveAttributeNode
Removes the specified attribute node.
(Inherited from Element.)
Public methodRemoveAttributeNS
Removes an attribute by local name and namespace URI.
(Inherited from Element.)
Public methodRemoveChild

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

Note: As long as a reference is kept on the removed child, it still exists in memory, but is no longer part of the DOM. It can still be reused later in the code. If the return value of removeChild() is not stored, and no other reference is kept, it will be automatically deleted from memory after a short time.
(Inherited from Node.)
Public methodRemoveEventListener(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.

(Inherited from EventTarget.)
Public methodRemoveEventListener(String, DOMEventHandler, Boolean)

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.

(Inherited from EventTarget.)
Public methodRemoveEventListener(String, IEventListener, Boolean)

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.

(Inherited from EventTarget.)
Public methodReplaceChild

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.

(Inherited from Node.)
Public methodReset
Restores a form element's default values. It performs the same action as a reset button.
Public methodSetAttribute
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
(Inherited from Element.)
Public methodSetAttributeNode
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.
(Inherited from Element.)
Public methodSetAttributeNodeNS
Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one.
(Inherited from Element.)
Public methodSetAttributeNS
Adds a new attribute. If an attribute with the same local name and namespace 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.
(Inherited from Element.)
Public methodSetIdAttribute
If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
(Inherited from Element.)
Public methodSetIdAttributeNode
If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
(Inherited from Element.)
Public methodSetIdAttributeNS
If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
(Inherited from Element.)
Public methodSubmit
Submits the form. It performs the same action as a submit button.
Public methodToString
Returns a String that represents this instance.
(Inherited from Node.)
Events
  NameDescription
Public eventOnAbort
Gets or sets event handler for OnAbort event.
(Inherited from HTMLElement.)
Public eventOnBlur
Gets or sets event handler for OnBlur event.
(Inherited from HTMLElement.)
Public eventOnCancel
Gets or sets event handler for OnCancel event.
(Inherited from HTMLElement.)
Public eventOnCanplay
Gets or sets event handler for OnCanplay event.
(Inherited from HTMLElement.)
Public eventOnCanPlayThrough
Gets or sets event handler for OnCanPlayThrough event.
(Inherited from HTMLElement.)
Public eventOnChange
Gets or sets event handler for OnChange event.
(Inherited from HTMLElement.)
Public eventOnClick
Gets or sets event handler for OnClick event.
(Inherited from HTMLElement.)
Public eventOnCueChange
Gets or sets event handler for OnCueChange event.
(Inherited from HTMLElement.)
Public eventOnDblClick
Gets or sets event handler for OnDblClick event.
(Inherited from HTMLElement.)
Public eventOnDurationChange
Gets or sets event handler for OnDurationChange event.
(Inherited from HTMLElement.)
Public eventOnEmptied
Gets or sets event handler for OnEmptied event.
(Inherited from HTMLElement.)
Public eventOnEnded
Gets or sets event handler for OnEnded event.
(Inherited from HTMLElement.)
Public eventOnError
Gets or sets event handler for OnError event.
(Inherited from HTMLElement.)
Public eventOnFocus
Gets or sets event handler for OnFocus event.
(Inherited from HTMLElement.)
Public eventOnInput
Gets or sets event handler for OnInput event.
(Inherited from HTMLElement.)
Public eventOnInvalid
Gets or sets event handler for OnInvalid event.
(Inherited from HTMLElement.)
Public eventOnKeyDown
Gets or sets event handler for OnKeyDown event.
(Inherited from HTMLElement.)
Public eventOnKeyPress
Gets or sets event handler for OnKeyPress event.
(Inherited from HTMLElement.)
Public eventOnKeyUp
Gets or sets event handler for OnKeyUp event.
(Inherited from HTMLElement.)
Public eventOnLoad
Gets or sets event handler for OnLoad event.
(Inherited from HTMLElement.)
Public eventOnLoadedData
Gets or sets event handler for OnLoadedData event.
(Inherited from HTMLElement.)
Public eventOnLoadedMetadata
Gets or sets event handler for OnLoadedMetadata event.
(Inherited from HTMLElement.)
Public eventOnLoadStart
Gets or sets event handler for OnLoadStart event.
(Inherited from HTMLElement.)
Public eventOnMouseDown
Gets or sets event handler for OnMouseDown event.
(Inherited from HTMLElement.)
Public eventOnMouseEnter
Gets or sets event handler for OnMouseEnter event.
(Inherited from HTMLElement.)
Public eventOnMouseLeave
Gets or sets event handler for OnMouseLeave event.
(Inherited from HTMLElement.)
Public eventOnMouseMove
Gets or sets event handler for OnMouseMove event.
(Inherited from HTMLElement.)
Public eventOnMouseOut
Gets or sets event handler for OnMouseOut event.
(Inherited from HTMLElement.)
Public eventOnMouseOver
Gets or sets event handler for OnMouseOver event.
(Inherited from HTMLElement.)
Public eventOnMouseUp
Gets or sets event handler for OnMouseUp event.
(Inherited from HTMLElement.)
Public eventOnMouseWheel
Gets or sets event handler for OnMouseWheel event.
(Inherited from HTMLElement.)
Public eventOnPause
Gets or sets event handler for OnPause event.
(Inherited from HTMLElement.)
Public eventOnPlay
Gets or sets event handler for OnPlay event.
(Inherited from HTMLElement.)
Public eventOnPlaying
Gets or sets event handler for OnPlaying event.
(Inherited from HTMLElement.)
Public eventOnProgress
Gets or sets event handler for OnProgress event.
(Inherited from HTMLElement.)
Public eventOnRateChange
Gets or sets event handler for OnRateChange event.
(Inherited from HTMLElement.)
Public eventOnReset
Gets or sets event handler for OnReset event.
(Inherited from HTMLElement.)
Public eventOnResize
Gets or sets event handler for OnResize event.
(Inherited from HTMLElement.)
Public eventOnScroll
Gets or sets event handler for OnScroll event.
(Inherited from HTMLElement.)
Public eventOnSeeked
Gets or sets event handler for OnSeeked event.
(Inherited from HTMLElement.)
Public eventOnSeeking
Gets or sets event handler for OnSeeking event.
(Inherited from HTMLElement.)
Public eventOnSelect
Gets or sets event handler for OnSelect event.
(Inherited from HTMLElement.)
Public eventOnShow
Gets or sets event handler for OnShow event.
(Inherited from HTMLElement.)
Public eventOnStalled
Gets or sets event handler for OnStalled event.
(Inherited from HTMLElement.)
Public eventOnSubmit
Gets or sets event handler for OnSubmit event.
(Inherited from HTMLElement.)
Public eventOnSuspend
Gets or sets event handler for OnSuspend event.
(Inherited from HTMLElement.)
Public eventOnTimeUpdate
Gets or sets event handler for OnTimeUpdate event.
(Inherited from HTMLElement.)
Public eventOnToggle
Gets or sets event handler for OnToggle event.
(Inherited from HTMLElement.)
Public eventOnVolumeChange
Gets or sets event handler for OnVolumeChange event.
(Inherited from HTMLElement.)
Public eventOnWaiting
Gets or sets event handler for OnWaiting event.
(Inherited from HTMLElement.)
See Also