Document

The Document interface 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.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.

@safe

interface Document : Node {

DocumentType doctype [@property getter];

DOMImplementation implementation [@property getter];

Element documentElement [@property getter];

Element createElement(DOMString tagName);

Element createElementNS(DOMString namespaceURI, DOMString qualifiedName);

DocumentFragment createDocumentFragment();

Text createTextNode(DOMString data);

Comment createComment(DOMString data);

CDATASection createCDATASection(DOMString data);

ProcessingInstruction createProcessingInstruction(DOMString target, DOMString data);

Attr createAttribute(DOMString name);

Attr createAttributeNS(DOMString namespaceURI, DOMString qualifiedName);

EntityReference createEntityReference(DOMString name);

NodeList getElementsByTagName(DOMString tagname);

NodeList getElementsByTagNameNS(DOMString namespaceURI, DOMString localName);

Element getElementById(DOMString elementId);

Node importNode(Node importedNode, bool deep);

Node adoptNode(Node source);

DOMString inputEncoding [@property getter];

DOMString xmlEncoding [@property getter];

bool xmlStandalone [@property getter];

bool xmlStandalone [@property setter];

DOMString xmlVersion [@property getter];

DOMString xmlVersion [@property setter];

bool strictErrorChecking [@property getter];

bool strictErrorChecking [@property setter];

DOMString documentURI [@property getter];

DOMString documentURI [@property setter];

DOMConfiguration domConfig [@property getter];

void normalizeDocument();

Node renameNode(Node n, DOMString namespaceURI, DOMString qualifiedName);

}

Members

Functions

adoptNode Node adoptNode(Node source): Moves node from another document, and returns it. Throws "NotSupportedError" DOMException if node is a document, or a "HierarchyRequestError" DOMException if node is a shadow root.
createAttribute Attr createAttribute(DOMString name): Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method. To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.
createAttributeNS Attr createAttributeNS(DOMString namespaceURI, DOMString qualifiedName): Creates an attribute of the given qualified name and namespace URI. Per the XML Namespaces specification, applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
createCDATASection CDATASection createCDATASection(DOMString data): Creates a CDATASection node whose value is the specified string.
createComment Comment createComment(DOMString data): Creates a Comment node given the specified string.
createDocumentFragment DocumentFragment createDocumentFragment(): Creates an empty DocumentFragment object.
createElement Element createElement(DOMString tagName): Creates an Element of the type specified. In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element. To create an Element with a qualified name and namespace URI, use the createElementNS method.
createElementNS Element createElementNS(DOMString namespaceURI, DOMString qualifiedName): Creates an Element of the given qualified name and namespace URI. Per the XML Namespaces specification, applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.
createEntityReference EntityReference createEntityReference(DOMString name): 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.
createProcessingInstruction ProcessingInstruction createProcessingInstruction(DOMString target, DOMString data): Creates a ProcessingInstruction node given the specified name and data strings.
createTextNode Text createTextNode(DOMString data): Creates a Text node given the specified string.
getElementById Element getElementById(DOMString elementId): 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. The DOM implementation is expected to use the attribute Attr.isId to determine if an attribute is of type ID.
getElementsByTagName NodeList getElementsByTagName(DOMString tagname): Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document.
getElementsByTagNameNS NodeList getElementsByTagNameNS(DOMString namespaceURI, DOMString localName): Returns a NodeList of all the Elements with a given local name and namespace URI in document order.
importNode Node importNode(Node importedNode, bool deep): 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. The returned node has no parent; (parentNode is null).
normalizeDocument void normalizeDocument(): This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree of EntityReference nodes and normalizes Text nodes, as defined in the method Node.normalize().
renameNode Node renameNode(Node n, DOMString namespaceURI, DOMString qualifiedName): Rename an existing node of type ELEMENT or ATTRIBUTE.

Properties

doctype DocumentType doctype [@property getter]: The DocumentType associated with this document. For XML documents without a document type declaration this returns null.
documentElement Element documentElement [@property getter]: This is a convenience attribute that allows direct access to the child node that is the document element of the document.
documentURI DOMString documentURI [@property getter]
DOMString documentURI [@property setter]: The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI.
domConfig DOMConfiguration domConfig [@property getter]: The configuration used when Document.normalizeDocument() is invoked.
implementation DOMImplementation implementation [@property getter]: The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.
inputEncoding DOMString inputEncoding [@property getter]: An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the Document was created in memory.
strictErrorChecking bool strictErrorChecking [@property getter]
bool strictErrorChecking [@property setter]: 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.
xmlEncoding DOMString xmlEncoding [@property getter]: An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.
xmlStandalone bool xmlStandalone [@property getter]
bool xmlStandalone [@property setter]: An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.
xmlVersion DOMString xmlVersion [@property getter]
DOMString xmlVersion [@property setter]: 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.

Inherited Members

From Node

nodeType NodeType nodeType [@property getter]: A code representing the type of the underlying object.
nodeName DOMString nodeName [@property getter]: The name of this node, depending on its type.
localName DOMString localName [@property getter]: Returns the local part of the qualified name of this node.
prefix DOMString prefix [@property getter]
DOMString prefix [@property setter]: The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable. Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change. For nodes of any type other than ELEMENT and ATTRIBUTE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
namespaceURI DOMString namespaceURI [@property getter]: The namespace URI of this node, or null if it is unspecified. This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time. For nodes of any type other than ELEMENT and ATTRIBUTE and nodes created with a DOM Level 1 method, such as Document.createElement, this is always null.
baseURI DOMString baseURI [@property getter]: The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI
nodeValue DOMString nodeValue [@property getter]
DOMString nodeValue [@property setter]: The value of this node, depending on its type.
textContent DOMString textContent [@property getter]: Returns the text content, if there's any.
textContent DOMString textContent [@property setter]: Sets the text content, it there's any.
parentNode Node parentNode [@property getter]: 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.
childNodes NodeList childNodes [@property getter]: A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
firstChild Node firstChild [@property getter]: The first child of this node. If there is no such node, this returns null.
lastChild Node lastChild [@property getter]: The last child of this node. If there is no such node, this returns null.
previousSibling Node previousSibling [@property getter]: The node immediately preceding this node. If there is no such node, this returns null.
nextSibling Node nextSibling [@property getter]: The node immediately following this node. If there is no such node, this returns null.
ownerDocument Document ownerDocument [@property getter]: The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
attributes NamedNodeMap attributes [@property getter]: A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
hasAttributes bool hasAttributes(): Returns whether this node (if it is an element) has any attributes.
insertBefore Node insertBefore(Node newChild, Node refChild): Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children. If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.
replaceChild Node replaceChild(Node newChild, Node oldChild): 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.
removeChild Node removeChild(Node oldChild): Removes the child node indicated by oldChild from the list of children, and returns it.
appendChild Node appendChild(Node newChild): Undocumented in source.
hasChildNodes bool hasChildNodes(): Returns whether this node has any children.
cloneNode Node cloneNode(bool deep): 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. User data associated to the imported node is not carried over. However, if any UserData handlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
isSameNode bool isSameNode(Node other): Undocumented in source.
isEqualNode bool isEqualNode(Node arg): Undocumented in source.
normalize void 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.
isSupported bool isSupported(string feature, string version_): Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
getFeature Object getFeature(string feature, string version_): Undocumented in source.
getUserData UserData getUserData(string key): Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.
setUserData UserData setUserData(string key, UserData data, UserDataHandler handler): Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.
compareDocumentPosition BitFlags!DocumentPosition compareDocumentPosition(Node other): Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.
lookupPrefix DOMString lookupPrefix(DOMString namespaceURI): Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
lookupNamespaceURI DOMString lookupNamespaceURI(DOMString prefix): Look up the namespace URI associated to the given prefix, starting from this node.
isDefaultNamespace bool isDefaultNamespace(DOMString namespaceURI): This method checks if the specified namespaceURI is the default namespace or not.