Document Class - Aspose.HTML for .NET

Document Class

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

Inheritance Hierarchy

SystemObject
  Aspose.Html.DomDOMObject
    Aspose.Html.DomEventTarget
      Aspose.Html.DomNode
        Aspose.Html.DomDocument
          Aspose.Html.Dom.SvgSVGDocument
          Aspose.HtmlHTMLDocument

Namespace: Aspose.Html.Dom
Assembly: Aspose.HTML (in Aspose.HTML.dll) Version: 20.3

Syntax

C++

public class Document : Node, IDocumentTraversal, 
	IXPathEvaluator, IDocumentEvent, IParentNode, IElementTraversal, INonElementParentNode, 
	IDocumentStyle, IGlobalEventHandlers

Public Class Document
	Inherits Node
	Implements IDocumentTraversal, IXPathEvaluator, IDocumentEvent, IParentNode, 
	IElementTraversal, INonElementParentNode, IDocumentStyle, IGlobalEventHandlers

public ref class Document : public Node, 
	IDocumentTraversal, IXPathEvaluator, IDocumentEvent, IParentNode, IElementTraversal, 
	INonElementParentNode, IDocumentStyle, IGlobalEventHandlers

type Document =  
    class
        inherit Node
        interface IDocumentTraversal
        interface IXPathEvaluator
        interface IDocumentEvent
        interface IParentNode
        interface IElementTraversal
        interface INonElementParentNode
        interface IDocumentStyle
        interface IGlobalEventHandlers
    end

The Document type exposes the following members.

Properties

	Name	Description
	Attributes	A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. (Inherited from Node.)
	BaseURI	The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. (Overrides NodeBaseURI.)
	CharacterSet	Gets the document's encoding.
	Charset	Gets the document's encoding.
	ChildElementCount	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.
	ChildNodes	A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.. (Inherited from Node.)
	Children	Returns the child elements.
	ContentType	Gets the document content type.
	Context	Gets the current browsing context.
	DefaultView	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.
	Doctype	The Document Type Declaration associated with this document.
	DocumentElement	This is a convenience attribute that allows direct access to the child node that is the document element of the document.
	DocumentURI	The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument.
	FirstChild	The first child of this node. If there is no such node, this returns null. (Inherited from Node.)
	FirstElementChild	Returns the first child element node of this element. null if this element has no child elements.
	Implementation	The DOMImplementation object that handles this document.
	InputEncoding	Gets the document's encoding.
	LastChild	The last child of this node. If there is no such node, this returns null. (Inherited from Node.)
	LastElementChild	Returns the last child element node of this element. null if this element has no child elements.
	LocalName	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.)
	Location	The location of the document.
	NamespaceURI	The namespace URI of this node, or null if it is unspecified. (Inherited from Node.)
	NextElementSibling	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.
	NextSibling	The node immediately following this node. If there is no such node, this returns null. (Inherited from Node.)
	NodeName	The name of this node, depending on its type. (Overrides NodeNodeName.)
	NodeType	A code representing the type of the underlying object. (Overrides NodeNodeType.)
	NodeValue	The value of this node, depending on its type. (Inherited from Node.)
	Origin	Gets the document origin.
	OwnerDocument	Gets the owner document. (Overrides NodeOwnerDocument.)
	ParentElement	Gets the parent Element of this node. (Inherited from Node.)
	ParentNode	The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null. (Inherited from Node.)
	Prefix	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 Node.)
	PreviousElementSibling	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.
	PreviousSibling	The node immediately preceding this node. If there is no such node, this returns null. (Inherited from Node.)
	ReadyState	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.
	StrictErrorChecking	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.
	StyleSheets	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.
	TextContent	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 Node.)
	XmlStandalone	An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.
	XmlVersion	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

	Name	Description
	AddEventListener(String, IEventListener)	This method allows the registration of event listeners on the event target. (Inherited from EventTarget.)
	AddEventListener(String, DOMEventHandler, Boolean)	This method allows the registration of event listeners on the event target. (Inherited from EventTarget.)
	AddEventListener(String, IEventListener, Boolean)	This method allows the registration of event listeners on the event target. (Inherited from EventTarget.)
	AppendChild	Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed. (Inherited from Node.)
	CloneNode	Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. (Inherited from Node.)
	CloneNode(Boolean)	Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. (Inherited from Node.)
	CreateAttribute	Creates an Attr of the given name.
	CreateAttributeNS	Creates an attribute of the given qualified name and namespace URI.
	CreateCDATASection	Creates a CDATASection node whose value is the specified string.
	CreateComment	Creates a Comment node given the specified string.
	CreateDocumentFragment	Creates an empty DocumentFragment object.
	CreateDocumentType	Creates a DocumentType node.
	CreateElement	Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
	CreateElementNS	Creates an element of the given qualified name and namespace URI.
	CreateEntityReference	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.
	CreateEvent	Creates an Event of a type supported by the implementation.
	CreateExpression	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.
	CreateNodeIterator(Node)	Create a new NodeIterator over the subtree rooted at the specified node.
	CreateNodeIterator(Node, Int64)	Create a new NodeIterator over the subtree rooted at the specified node.
	CreateNodeIterator(Node, Int64, INodeFilter)	Create a new NodeIterator over the subtree rooted at the specified node.
	CreateNSResolver	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.
	CreateProcessingInstruction	Creates a ProcessingInstruction node given the specified name and data strings.
	CreateTextNode	Creates a Text node given the specified string.
	CreateTreeWalker(Node)	Create a new TreeWalker over the subtree rooted at the specified node.
	CreateTreeWalker(Node, Int64)	Create a new TreeWalker over the subtree rooted at the specified node.
	CreateTreeWalker(Node, Int64, INodeFilter)	Create a new TreeWalker over the subtree rooted at the specified node.
	DispatchEvent	This method allows the dispatch of events into the implementations event model. (Inherited from EventTarget.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from EventTarget.)
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources. (Overrides NodeDispose(Boolean).)
	Equals	(Inherited from Object.)
	Evaluate	Evaluates an XPath expression string and returns a result of the specified type if possible.
	Finalize	Finalizes an instance of the Node class. (Inherited from Node.)
	GetElementById	Returns the Element that has an ID attribute with the given value. If no such element exists, this returns null. If more than one element has an ID attribute with that value, what is returned is undefined.
	GetElementsByClassName	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/
	GetElementsByTagName	Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.
	GetElementsByTagNameNS	Returns a NodeList of all the Elements with a given local name and namespace URI in document order.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	HasAttributes	Returns whether this node (if it is an element) has any attributes (Inherited from Node.)
	HasChildNodes	Returns whether this node has any children. (Inherited from Node.)
	ImportNode	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.
	InsertBefore	Inserts the node before the existing child node child. If child is null, insert node at the end of the list of children. If child is a DocumentFragment object, all of its children are inserted, in the same order, before child. If the child is already in the tree, it is first removed. (Inherited from Node.)
	IsDefaultNamespace	This method checks if the specified namespaceURI is the default namespace or not. (Inherited from Node.)
	IsEqualNode	Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true. (Inherited from Node.)
	IsSameNode	Returns whether this node is the same node as the given one. This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect. (Inherited from Node.)
	LookupNamespaceURI	Look up the namespace URI associated to the given prefix, starting from this node. (Inherited from Node.)
	LookupPrefix	Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See Namespace Prefix Lookup for details on the algorithm used by this method. (Inherited from Node.)
	MemberwiseClone	(Inherited from Object.)
	Navigate(String)	Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content.
	Navigate(RequestMessage)	Loads the document based on specified request object, replacing the previous content.
	Navigate(Url)	Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content.
	Navigate(Stream, String)	Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content.
	Navigate(String, String)	Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content.
	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. (Inherited from Node.)
	QuerySelector	Returns the first Element in document, which match selector
	QuerySelectorAll	Returns a NodeList of all the Elements in document, which match selector
	RemoveChild	Removes the child node indicated by oldChild from the list of children, and returns it. (Inherited from Node.)
	RemoveEventListener(String, IEventListener)	This method allows the removal of event listeners from the event target. If an IEventListener is removed from an EventTarget 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.)
	RemoveEventListener(String, DOMEventHandler, Boolean)	This method allows the removal of event listeners from the event target. If an IEventListener is removed from an EventTarget 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.)
	RemoveEventListener(String, IEventListener, Boolean)	This method allows the removal of event listeners from the event target. If an IEventListener is removed from an EventTarget 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.)
	RenderTo	This method is used to render the contents of the current document to a specified graphical device.
	ReplaceChild	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.)
	ToString	Returns a String that represents this instance. (Inherited from Node.)
	Write	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.
	WriteLn	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

	Name	Description
	OnAbort	Gets or sets event handler for OnAbort event.
	OnBlur	Gets or sets event handler for OnBlur event.
	OnCancel	Gets or sets event handler for OnCancel event.
	OnCanplay	Gets or sets event handler for OnCanplay event.
	OnCanPlayThrough	Gets or sets event handler for OnCanPlayThrough event.
	OnChange	Gets or sets event handler for OnChange event.
	OnClick	Gets or sets event handler for OnClick event.
	OnCueChange	Gets or sets event handler for OnCueChange event.
	OnDblClick	Gets or sets event handler for OnDblClick event.
	OnDurationChange	Gets or sets event handler for OnDurationChange event.
	OnEmptied	Gets or sets event handler for OnEmptied event.
	OnEnded	Gets or sets event handler for OnEnded event.
	OnError	Gets or sets event handler for OnError event.
	OnFocus	Gets or sets event handler for OnFocus event.
	OnInput	Gets or sets event handler for OnInput event.
	OnInvalid	Gets or sets event handler for OnInvalid event.
	OnKeyDown	Gets or sets event handler for OnKeyDown event.
	OnKeyPress	Gets or sets event handler for OnKeyPress event.
	OnKeyUp	Gets or sets event handler for OnKeyUp event.
	OnLoad	Gets or sets event handler for OnLoad event.
	OnLoadedData	Gets or sets event handler for OnLoadedData event.
	OnLoadedMetadata	Gets or sets event handler for OnLoadedMetadata event.
	OnLoadStart	Gets or sets event handler for OnLoadStart event.
	OnMouseDown	Gets or sets event handler for OnMouseDown event.
	OnMouseEnter	Gets or sets event handler for OnMouseEnter event.
	OnMouseLeave	Gets or sets event handler for OnMouseLeave event.
	OnMouseMove	Gets or sets event handler for OnMouseMove event.
	OnMouseOut	Gets or sets event handler for OnMouseOut event.
	OnMouseOver	Gets or sets event handler for OnMouseOver event.
	OnMouseUp	Gets or sets event handler for OnMouseUp event.
	OnMouseWheel	Gets or sets event handler for OnMouseWheel event.
	OnPause	Gets or sets event handler for OnPause event.
	OnPlay	Gets or sets event handler for OnPlay event.
	OnPlaying	Gets or sets event handler for OnPlaying event.
	OnProgress	Gets or sets event handler for OnProgress event.
	OnRateChange	Gets or sets event handler for OnRateChange event.
	OnReadyStateChange	Gets or sets event handler for OnReadyStateChange event.
	OnReset	Gets or sets event handler for OnReset event.
	OnResize	Gets or sets event handler for OnResize event.
	OnScroll	Gets or sets event handler for OnScroll event.
	OnSeeked	Gets or sets event handler for OnSeeked event.
	OnSeeking	Gets or sets event handler for OnSeeking event.
	OnSelect	Gets or sets event handler for OnSelect event.
	OnShow	Gets or sets event handler for OnShow event.
	OnStalled	Gets or sets event handler for OnStalled event.
	OnSubmit	Gets or sets event handler for OnSubmit event.
	OnSuspend	Gets or sets event handler for OnSuspend event.
	OnTimeUpdate	Gets or sets event handler for OnTimeUpdate event.
	OnToggle	Gets or sets event handler for OnToggle event.
	OnVolumeChange	Gets or sets event handler for OnVolumeChange event.
	OnWaiting	Gets or sets event handler for OnWaiting event.

Reference

Aspose.Html.Dom Namespace