Document Class
The Document represents the entire HTML, XML or SVG document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
Inheritance Hierarchy

Namespace: Aspose.Html.Dom
Assembly: Aspose.HTML (in Aspose.HTML.dll) Version: 22.1
Syntax
public class Document : Node, IDocumentTraversal, 
	IXPathEvaluator, IDocumentEvent, IParentNode, IElementTraversal, INonElementParentNode, 
	IDocumentStyle, IGlobalEventHandlers

The Document type exposes the following members.

Constructors
  NameDescription
Protected methodDocument
Initializes a new instance of the Document class.
Properties
  NameDescription
Public propertyAttributes

The attributes property returns a live collection of all attribute nodes registered to the specified node. Attributes is a key/value pair of strings that represents any information regarding that attribute.

(Inherited from Node.)
Public propertyBaseURI
The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
(Overrides NodeBaseURI.)
Public propertyCharacterSet
Gets the document's encoding.
Public propertyCharset
Gets the document's encoding.
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.
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.
Public propertyContentType
Gets the document content type.
Public propertyContext
Gets the current browsing context.
Public propertyDefaultView
The defaultView IDL attribute of the Document interface, on getting, must return this Document's browsing context's WindowProxy object, if this Document has an associated browsing context, or null otherwise.
Public propertyDoctype
The Document Type Declaration associated with this document.
Public propertyDocumentElement
This is a convenience attribute that allows direct access to the child node that is the document element of the document.
Public propertyDocumentURI
The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
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.
Public propertyImplementation
The DOMImplementation object that handles this document.
Public propertyInputEncoding
Gets the document's encoding.
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.
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 Node.)
Public propertyLocation
The location of the document.
Public propertyNamespaceURI

The Element.namespaceURI read-only property returns the namespace URI of the element, or null if the element is not in a namespace.

(Inherited from Node.)
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.
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.
(Overrides NodeNodeName.)
Public propertyNodeType
A code representing the type of the underlying object.
(Overrides NodeNodeType.)
Public propertyNodeValue

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

(Inherited from Node.)
Public propertyOrigin
Gets the document origin.
Public propertyOwnerDocument
Gets the owner document.
(Overrides NodeOwnerDocument.)
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 prefix read-only property returns the namespace prefix of the specified element, or null if no prefix is specified.

(Inherited from Node.)
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.
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 propertyReadyState
Returns the document readiness. The "loading" while the Document is loading, "interactive" once it is finished parsing but still loading sub-resources, and "complete" once it has loaded.
Public propertyStrictErrorChecking
An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
Public propertyStyleSheets
A list containing all the style sheets explicitly linked into or embedded in a document. For HTML documents, this includes external style sheets, included via the HTML LINK element, and inline STYLE elements.
Public propertyTextContent

The textContent property of the Node interface represents the text content of the node and its descendants.

(Inherited from Node.)
Public propertyXmlStandalone
An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.
Public propertyXmlVersion
An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null.
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 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 methodCode exampleCreateAttribute

The Document.createAttribute() method creates a new attribute node, and returns it. The object created a node implementing the Attr interface. The DOM does not enforce what sort of attributes can be added to a particular element in this manner.

Public methodCreateAttributeNS

The Document.createAttribute() method creates a new attribute node, and returns it. The object created a node implementing the Attr interface. The DOM does not enforce what sort of attributes can be added to a particular element in this manner.

Public methodCode exampleCreateCDATASection

Creates a CDATASection node whose value is the specified string.

Public methodCode exampleCreateComment

Creates a Comment node given the specified string.

Public methodCode exampleCreateDocumentFragment

Creates a new empty DocumentFragment into which DOM nodes can be added to build an offscreen DOM tree.

Public methodCode exampleCreateDocumentType

The method returns a DocumentType object which can either be used with DOMImplementation.createDocument upon document creation or can be put into the document via methods like Node.insertBefore() or Node.replaceChild().

Public methodCode exampleCreateElement

In an HTML document, the document.createElement() method creates the HTML element specified by tagName, or an HTMLUnknownElement if tagName isn't recognized.

Public methodCreateElementNS
Creates an element of the given qualified name and namespace URI.
Public methodCreateEntityReference
Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.
Public methodCreateEvent
Creates an Event of a type supported by the implementation.
Public methodCreateExpression
Creates a parsed XPath expression with resolved namespaces. This is useful when an expression will be reused in an application since it makes it possible to compile the expression string into a more efficient internal form and preresolve all namespace prefixes which occur within the expression.
Public methodCreateNodeIterator(Node)
Create a new NodeIterator over the subtree rooted at the specified node.
Public methodCreateNodeIterator(Node, Int64)
Create a new NodeIterator over the subtree rooted at the specified node.
Public methodCreateNodeIterator(Node, Int64, INodeFilter)
Create a new NodeIterator over the subtree rooted at the specified node.
Public methodCreateNSResolver
Adapts any DOM node to resolve namespaces so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document. This adapter works like the DOM Level 3 method lookupNamespaceURI on nodes in resolving the namespaceURI from a given prefix using the current information available in the node's hierarchy at the time lookupNamespaceURI is called, also correctly resolving the implicit xml prefix.
Public methodCreateProcessingInstruction
Creates a ProcessingInstruction node given the specified name and data strings.
Public methodCreateTextNode
Creates a Text node given the specified string.
Public methodCreateTreeWalker(Node)
Create a new TreeWalker over the subtree rooted at the specified node.
Public methodCreateTreeWalker(Node, Int64)
Create a new TreeWalker over the subtree rooted at the specified node.
Public methodCreateTreeWalker(Node, Int64, INodeFilter)
Create a new TreeWalker over the subtree rooted at the specified 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.
(Overrides NodeDispose(Boolean).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEvaluate
Evaluates an XPath expression string and returns a result of the specified type if possible.
Protected methodFinalize
Finalizes an instance of the Node class.
(Inherited from Node.)
Public methodCode exampleGetElementById

The Document method getElementById() returns an Element object representing the element whose id property matches the specified string. Since element IDs are required to be unique if specified, they're a useful way to get access to a specific element quickly.

If you need to get access to an element which doesn't have an ID, you can use querySelector() to find the element using any selector.

Public methodCode exampleGetElementsByClassName

The getElementsByClassName method of Document interface returns an array-like object of all child elements which have all of the given class name(s).

When called on the document object, the complete document is searched, including the root node. You may also call getElementsByClassName() on any element; it will return only elements which are descendants of the specified root element with the given class name(s).

Public methodCode exampleGetElementsByTagName

The getElementsByTagName method of Document interface returns an HTMLCollection of elements with the given tag name.

The complete document is searched, including the root node. The returned HTMLCollection is live, meaning that it updates itself automatically to stay in sync with the DOM tree without having to call document.getElementsByTagName() again.

Public methodCode exampleGetElementsByTagNameNS

Returns a list of elements with the given tag name belonging to the given namespace. The complete document is searched, including the root node.

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 methodHasAttributes

The hasAttributes() method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.

(Inherited from Node.)
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 methodImportNode
Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source 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 methodNavigate(String)
Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content.
Public methodNavigate(RequestMessage)
Loads the document based on specified request object, replacing the previous content.
Public methodNavigate(Url)
Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content.
Public methodNavigate(Stream, Url)
Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. Document loading starts from the current position in the stream.
Public methodNavigate(Stream, String)
Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. Document loading starts from the current position in the stream.
Public methodNavigate(String, Url)
Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content.
Public methodNavigate(String, String)
Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content.
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
Public methodQuerySelectorAll
Returns a NodeList of all the Elements in document, which match selector
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 methodRenderTo
This method is used to render the contents of the current document to a specified graphical device.
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 methodToString
Returns a String that represents this instance.
(Inherited from Node.)
Public methodWrite
Write a string of text to a document stream opened by open(). Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document.
Public methodWriteLn
Write a string of text followed by a newline character to a document stream opened by open(). Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document
Events
  NameDescription
Public eventOnAbort
Gets or sets event handler for OnAbort event.
Public eventOnBlur
Gets or sets event handler for OnBlur event.
Public eventOnCancel
Gets or sets event handler for OnCancel event.
Public eventOnCanplay
Gets or sets event handler for OnCanplay event.
Public eventOnCanPlayThrough
Gets or sets event handler for OnCanPlayThrough event.
Public eventOnChange
Gets or sets event handler for OnChange event.
Public eventOnClick
Gets or sets event handler for OnClick event.
Public eventOnCueChange
Gets or sets event handler for OnCueChange event.
Public eventOnDblClick
Gets or sets event handler for OnDblClick event.
Public eventOnDurationChange
Gets or sets event handler for OnDurationChange event.
Public eventOnEmptied
Gets or sets event handler for OnEmptied event.
Public eventOnEnded
Gets or sets event handler for OnEnded event.
Public eventOnError
Gets or sets event handler for OnError event.
Public eventOnFocus
Gets or sets event handler for OnFocus event.
Public eventOnInput
Gets or sets event handler for OnInput event.
Public eventOnInvalid
Gets or sets event handler for OnInvalid event.
Public eventOnKeyDown
Gets or sets event handler for OnKeyDown event.
Public eventOnKeyPress
Gets or sets event handler for OnKeyPress event.
Public eventOnKeyUp
Gets or sets event handler for OnKeyUp event.
Public eventOnLoad
Gets or sets event handler for OnLoad event.
Public eventOnLoadedData
Gets or sets event handler for OnLoadedData event.
Public eventOnLoadedMetadata
Gets or sets event handler for OnLoadedMetadata event.
Public eventOnLoadStart
Gets or sets event handler for OnLoadStart event.
Public eventOnMouseDown
Gets or sets event handler for OnMouseDown event.
Public eventOnMouseEnter
Gets or sets event handler for OnMouseEnter event.
Public eventOnMouseLeave
Gets or sets event handler for OnMouseLeave event.
Public eventOnMouseMove
Gets or sets event handler for OnMouseMove event.
Public eventOnMouseOut
Gets or sets event handler for OnMouseOut event.
Public eventOnMouseOver
Gets or sets event handler for OnMouseOver event.
Public eventOnMouseUp
Gets or sets event handler for OnMouseUp event.
Public eventOnMouseWheel
Gets or sets event handler for OnMouseWheel event.
Public eventOnPause
Gets or sets event handler for OnPause event.
Public eventOnPlay
Gets or sets event handler for OnPlay event.
Public eventOnPlaying
Gets or sets event handler for OnPlaying event.
Public eventOnProgress
Gets or sets event handler for OnProgress event.
Public eventOnRateChange
Gets or sets event handler for OnRateChange event.
Public eventOnReadyStateChange
Gets or sets event handler for OnReadyStateChange event.
Public eventOnReset
Gets or sets event handler for OnReset event.
Public eventOnResize
Gets or sets event handler for OnResize event.
Public eventOnScroll
Gets or sets event handler for OnScroll event.
Public eventOnSeeked
Gets or sets event handler for OnSeeked event.
Public eventOnSeeking
Gets or sets event handler for OnSeeking event.
Public eventOnSelect
Gets or sets event handler for OnSelect event.
Public eventOnShow
Gets or sets event handler for OnShow event.
Public eventOnStalled
Gets or sets event handler for OnStalled event.
Public eventOnSubmit
Gets or sets event handler for OnSubmit event.
Public eventOnSuspend
Gets or sets event handler for OnSuspend event.
Public eventOnTimeUpdate
Gets or sets event handler for OnTimeUpdate event.
Public eventOnToggle
Gets or sets event handler for OnToggle event.
Public eventOnVolumeChange
Gets or sets event handler for OnVolumeChange event.
Public eventOnWaiting
Gets or sets event handler for OnWaiting event.
See Also