XMLDocument extension type

The XMLDocument interface represents an XML document. It inherits from the generic Document and does not add any specific methods or properties to it: nevertheless, several algorithms behave differently with the two types of documents.

on

• JSObject

Implemented types

• Document
• JSObject

Available extensions

• DocumentCustomEvents
• JSObjectUnsafeUtilExtension
• NodeGlue

Properties

activeElement → Element?

no setter, inherited

adoptedStyleSheets ↔ JSArray<CSSStyleSheet>

getter/setter pair, inherited

alinkColor ↔ String

getter/setter pair, inherited

all → HTMLAllCollection

no setter, inherited

anchors → HTMLCollection

no setter, inherited

applets → HTMLCollection

no setter, inherited

baseURI → String

no setter, inherited

bgColor ↔ String

getter/setter pair, inherited

body ↔ HTMLElement?

getter/setter pair, inherited

characterSet → String

no setter, inherited

charset → String

no setter, inherited

childElementCount → int

no setter, inherited

childNodes → NodeList

no setter, inherited

children → HTMLCollection

no setter, inherited

compatMode → String

no setter, inherited

contentType → String

no setter, inherited

cookie ↔ String

getter/setter pair, inherited

currentScript → HTMLOrSVGScriptElement?

no setter, inherited

defaultView → Window?

no setter, inherited

designMode ↔ String

getter/setter pair, inherited

dir ↔ String

getter/setter pair, inherited

doctype → DocumentType?

no setter, inherited

documentElement → Element?

no setter, inherited

documentURI → String

no setter, inherited

domain ↔ String

getter/setter pair, inherited

embeds → HTMLCollection

no setter, inherited

fgColor ↔ String

getter/setter pair, inherited

firstChild → Node?

no setter, inherited

firstElementChild → Element?

no setter, inherited

fonts → FontFaceSet

no setter, inherited

forms → HTMLCollection

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

head → HTMLHeadElement?

no setter, inherited

hidden → bool

no setter, inherited

images → HTMLCollection

no setter, inherited

implementation → DOMImplementation

no setter, inherited

inputEncoding → String

no setter, inherited

isConnected → bool

no setter, inherited

lastChild → Node?

no setter, inherited

lastElementChild → Element?

no setter, inherited

lastModified → String

no setter, inherited

linkColor ↔ String

getter/setter pair, inherited

links → HTMLCollection

no setter, inherited

location → Location?

no setter, inherited

nextSibling → Node?

no setter, inherited

nodeName → String

no setter, inherited

nodeType → int

no setter, inherited

nodeValue ↔ String?

getter/setter pair, inherited

onabort ↔ EventHandler?

getter/setter pair, inherited

onanimationcancel ↔ EventHandler?

getter/setter pair, inherited

onanimationend ↔ EventHandler?

getter/setter pair, inherited

onanimationiteration ↔ EventHandler?

getter/setter pair, inherited

onanimationstart ↔ EventHandler?

getter/setter pair, inherited

onauxclick ↔ EventHandler?

getter/setter pair, inherited

onbeforeinput ↔ EventHandler?

getter/setter pair, inherited

onbeforematch ↔ EventHandler?

getter/setter pair, inherited

onbeforetoggle ↔ EventHandler?

getter/setter pair, inherited

onblur ↔ EventHandler?

getter/setter pair, inherited

oncancel ↔ EventHandler?

getter/setter pair, inherited

oncanplay ↔ EventHandler?

getter/setter pair, inherited

oncanplaythrough ↔ EventHandler?

getter/setter pair, inherited

onchange ↔ EventHandler?

getter/setter pair, inherited

onclick ↔ EventHandler?

getter/setter pair, inherited

onclose ↔ EventHandler?

getter/setter pair, inherited

oncontextlost ↔ EventHandler?

getter/setter pair, inherited

oncontextmenu ↔ EventHandler?

getter/setter pair, inherited

oncontextrestored ↔ EventHandler?

getter/setter pair, inherited

oncopy ↔ EventHandler?

getter/setter pair, inherited

oncuechange ↔ EventHandler?

getter/setter pair, inherited

oncut ↔ EventHandler?

getter/setter pair, inherited

ondblclick ↔ EventHandler?

getter/setter pair, inherited

ondrag ↔ EventHandler?

getter/setter pair, inherited

ondragend ↔ EventHandler?

getter/setter pair, inherited

ondragenter ↔ EventHandler?

getter/setter pair, inherited

ondragleave ↔ EventHandler?

getter/setter pair, inherited

ondragover ↔ EventHandler?

getter/setter pair, inherited

ondragstart ↔ EventHandler?

getter/setter pair, inherited

ondrop ↔ EventHandler?

getter/setter pair, inherited

ondurationchange ↔ EventHandler?

getter/setter pair, inherited

onemptied ↔ EventHandler?

getter/setter pair, inherited

onended ↔ EventHandler?

getter/setter pair, inherited

onerror ↔ OnErrorEventHandler?

getter/setter pair, inherited

onfocus ↔ EventHandler?

getter/setter pair, inherited

onformdata ↔ EventHandler?

getter/setter pair, inherited

ongotpointercapture ↔ EventHandler?

getter/setter pair, inherited

oninput ↔ EventHandler?

getter/setter pair, inherited

oninvalid ↔ EventHandler?

getter/setter pair, inherited

onkeydown ↔ EventHandler?

getter/setter pair, inherited

onkeypress ↔ EventHandler?

getter/setter pair, inherited

onkeyup ↔ EventHandler?

getter/setter pair, inherited

onload ↔ EventHandler?

getter/setter pair, inherited

onloadeddata ↔ EventHandler?

getter/setter pair, inherited

onloadedmetadata ↔ EventHandler?

getter/setter pair, inherited

onloadstart ↔ EventHandler?

getter/setter pair, inherited

onlostpointercapture ↔ EventHandler?

getter/setter pair, inherited

onmousedown ↔ EventHandler?

getter/setter pair, inherited

onmouseenter ↔ EventHandler?

getter/setter pair, inherited

onmouseleave ↔ EventHandler?

getter/setter pair, inherited

onmousemove ↔ EventHandler?

getter/setter pair, inherited

onmouseout ↔ EventHandler?

getter/setter pair, inherited

onmouseover ↔ EventHandler?

getter/setter pair, inherited

onmouseup ↔ EventHandler?

getter/setter pair, inherited

onpaste ↔ EventHandler?

getter/setter pair, inherited

onpause ↔ EventHandler?

getter/setter pair, inherited

onplay ↔ EventHandler?

getter/setter pair, inherited

onplaying ↔ EventHandler?

getter/setter pair, inherited

onpointercancel ↔ EventHandler?

getter/setter pair, inherited

onpointerdown ↔ EventHandler?

getter/setter pair, inherited

onpointerenter ↔ EventHandler?

getter/setter pair, inherited

onpointerleave ↔ EventHandler?

getter/setter pair, inherited

onpointermove ↔ EventHandler?

getter/setter pair, inherited

onpointerout ↔ EventHandler?

getter/setter pair, inherited

onpointerover ↔ EventHandler?

getter/setter pair, inherited

onpointerrawupdate ↔ EventHandler?

getter/setter pair, inherited

onpointerup ↔ EventHandler?

getter/setter pair, inherited

onprogress ↔ EventHandler?

getter/setter pair, inherited

onratechange ↔ EventHandler?

getter/setter pair, inherited

onreadystatechange ↔ EventHandler?

getter/setter pair, inherited

onreset ↔ EventHandler?

getter/setter pair, inherited

onresize ↔ EventHandler?

getter/setter pair, inherited

onscroll ↔ EventHandler?

getter/setter pair, inherited

onscrollend ↔ EventHandler?

getter/setter pair, inherited

onsecuritypolicyviolation ↔ EventHandler?

getter/setter pair, inherited

onseeked ↔ EventHandler?

getter/setter pair, inherited

onseeking ↔ EventHandler?

getter/setter pair, inherited

onselect ↔ EventHandler?

getter/setter pair, inherited

onselectionchange ↔ EventHandler?

getter/setter pair, inherited

onselectstart ↔ EventHandler?

getter/setter pair, inherited

onslotchange ↔ EventHandler?

getter/setter pair, inherited

onstalled ↔ EventHandler?

getter/setter pair, inherited

onsubmit ↔ EventHandler?

getter/setter pair, inherited

onsuspend ↔ EventHandler?

getter/setter pair, inherited

ontimeupdate ↔ EventHandler?

getter/setter pair, inherited

ontoggle ↔ EventHandler?

getter/setter pair, inherited

ontouchcancel ↔ EventHandler?

getter/setter pair, inherited

ontouchend ↔ EventHandler?

getter/setter pair, inherited

ontouchmove ↔ EventHandler?

getter/setter pair, inherited

ontouchstart ↔ EventHandler?

getter/setter pair, inherited

ontransitioncancel ↔ EventHandler?

getter/setter pair, inherited

ontransitionend ↔ EventHandler?

getter/setter pair, inherited

ontransitionrun ↔ EventHandler?

getter/setter pair, inherited

ontransitionstart ↔ EventHandler?

getter/setter pair, inherited

onvisibilitychange ↔ EventHandler?

getter/setter pair, inherited

onvolumechange ↔ EventHandler?

getter/setter pair, inherited

onwaiting ↔ EventHandler?

getter/setter pair, inherited

onwebkitanimationend ↔ EventHandler?

getter/setter pair, inherited

onwebkitanimationiteration ↔ EventHandler?

getter/setter pair, inherited

onwebkitanimationstart ↔ EventHandler?

getter/setter pair, inherited

onwebkittransitionend ↔ EventHandler?

getter/setter pair, inherited

onwheel ↔ EventHandler?

getter/setter pair, inherited

ownerDocument → Document?

no setter, inherited

parentElement → Element?

no setter, inherited

parentNode → Node?

no setter, inherited

plugins → HTMLCollection

no setter, inherited

previousSibling → Node?

no setter, inherited

readyState → DocumentReadyState

no setter, inherited

referrer → String

no setter, inherited

rootElement → SVGSVGElement?

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scripts → HTMLCollection

no setter, inherited

scrollingElement → Element?

no setter, inherited

styleSheets → StyleSheetList

no setter, inherited

textContent ↔ String?

getter/setter pair, inherited

timeline → DocumentTimeline

no setter, inherited

title ↔ String

getter/setter pair, inherited

URL → String

no setter, inherited

visibilityState → DocumentVisibilityState

no setter, inherited

vlinkColor ↔ String

getter/setter pair, inherited

Methods

addEventListener(String type, EventListener? callback, [JSAny options]) → void

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

inherited

adoptNode(Node node) → Node

Document.adoptNode() transfers a from another Document into the method's document. The adopted node and its subtree are removed from their original document (if any), and their Node.ownerDocument is changed to the current document. The node can then be inserted into the current document.

inherited

append(JSAny nodes) → void

The Document.append() method inserts a set of Node objects or string objects after the last child of the document. String objects are inserted as equivalent Text nodes.

inherited

appendChild(Node node) → Node

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

inherited

captureEvents() → void

inherited

caretPositionFromPoint(num x, num y) → CaretPosition?

The caretPositionFromPoint() method of the Document interface returns a CaretPosition object, containing the DOM node, along with the caret and caret's character offset within that node.

inherited

clear() → void

The Document.clear() method does nothing, but doesn't raise any error.

inherited

cloneNode([bool deep]) → Node

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.

inherited

close() → void

The Document.close() method finishes writing to a document, opened with Document.open.

inherited

compareDocumentPosition(Node other) → int

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

inherited

contains(Node? other) → bool

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.

inherited

convertPointFromNode(DOMPointInit point, GeometryNode from, [ConvertCoordinateOptions options]) → DOMPoint

inherited

convertQuadFromNode(DOMQuadInit quad, GeometryNode from, [ConvertCoordinateOptions options]) → DOMQuad

inherited

convertRectFromNode(DOMRectReadOnly rect, GeometryNode from, [ConvertCoordinateOptions options]) → DOMQuad

inherited

createAttribute(String localName) → Attr

The Document.createAttribute() method creates a new attribute node, and returns it. The object created is 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.

inherited

createAttributeNS(String? namespace, String qualifiedName) → Attr

The Document.createAttributeNS() method creates a new attribute node with the specified namespace URI and qualified name, and returns it. The object created is 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.

inherited

createCDATASection(String data) → CDATASection

createCDATASection() creates a new CDATA section node, and returns it.

inherited

createComment(String data) → Comment

createComment() creates a new comment node, and returns it.

inherited

createDocumentFragment() → DocumentFragment

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

inherited

createElement(String localName, [JSAny options]) → Element

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

inherited

createElementNS(String? namespace, String qualifiedName, [JSAny options]) → Element

Creates an element with the specified namespace URI and qualified name.

inherited

createEvent(String interface) → Event

Warning: Many methods used with createEvent, such as initCustomEvent, are deprecated. Use event constructors instead.

inherited

createExpression(String expression, [XPathNSResolver? resolver]) → XPathExpression

This method compiles an XPathExpression which can then be used for (repeated) evaluations.

inherited

createNodeIterator(Node root, [int whatToShow, NodeFilter? filter]) → NodeIterator

The Document.createNodeIterator() method returns a new NodeIterator object.

inherited

createNSResolver(Node nodeResolver) → Node

Creates an XPathNSResolver which resolves namespaces with respect to the definitions in scope for a specified node.

inherited

createProcessingInstruction(String target, String data) → ProcessingInstruction

createProcessingInstruction() generates a new processing instruction node and returns it.

inherited

createRange() → Range

The Document.createRange() method returns a new Range object.

inherited

createTextNode(String data) → Text

Creates a new Text node. This method can be used to escape HTML characters.

inherited

createTreeWalker(Node root, [int whatToShow, NodeFilter? filter]) → TreeWalker

The Document.createTreeWalker() creator method returns a newly created TreeWalker object.

inherited

dispatchEvent(Event event) → bool

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners 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

elementFromPoint(num x, num y) → Element?

The elementFromPoint() method, available on the Document object, returns the topmost Element at the specified coordinates (relative to the viewport).

inherited

elementsFromPoint(num x, num y) → JSArray<Element>

The elementsFromPoint() method of the Document interface returns an array of all elements at the specified coordinates (relative to the viewport). The elements are ordered from the topmost to the bottommost box of the viewport.

inherited

evaluate(String expression, Node contextNode, [XPathNSResolver? resolver, int type, XPathResult? result]) → XPathResult

The evaluate() method of the Document interface selects elements based on the XPath expression given in parameters.

inherited

execCommand(String commandId, [bool showUI, String value]) → bool

The execCommand method implements multiple different commands. Some of them provide access to the clipboard, while others are for editing form inputs, contenteditable elements or entire documents (when switched to design mode).

inherited

getAnimations() → JSArray<Animation>

The getAnimations() method of the Document interface returns an array of all Animation objects currently in effect whose target elements are descendants of the document. This array includes CSS Animations, CSS Transitions, and Web Animations.

inherited

getBoxQuads([BoxQuadOptions options]) → JSArray<DOMQuad>

inherited

getElementById(String elementId) → Element?

The getElementById() method of the Document interface returns an Element object representing the element whose Element.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.

inherited

getElementsByClassName(String classNames) → HTMLCollection

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

inherited

getElementsByName(String elementName) → NodeList

The getElementsByName() method of the Document object returns a NodeList Collection of elements with a given name attribute in the document.

inherited

getElementsByTagName(String qualifiedName) → HTMLCollection

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

inherited

getElementsByTagNameNS(String? namespace, String localName) → HTMLCollection

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

inherited

getRootNode([GetRootNodeOptions options]) → Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

inherited

getSelection() → Selection?

The getSelection() method of the Document interface returns a Selection object representing the range of text selected by the user, or the current position of the caret.

inherited

hasChildNodes() → bool

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

inherited

hasFocus() → bool

The hasFocus() method of the Document interface returns a boolean value indicating whether the document or any element inside the document has focus. This method can be used to determine whether the active element in a document has focus.

inherited

importNode(Node node, [bool deep]) → Node

The Document object's importNode() method creates a copy of a Node or DocumentFragment from another document, to be inserted into the current document later.

inherited

insertBefore(Node node, Node? child) → Node

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

inherited

isDefaultNamespace(String? namespace) → bool

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.

inherited

isEqualNode(Node? otherNode) → bool

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

isSameNode(Node? otherNode) → bool

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

inherited

lookupNamespaceURI(String? prefix) → String?

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

lookupPrefix(String? namespace) → String?

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

normalize() → void

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

open([String unused1OrUrl, String nameOrUnused2, String features]) → JSObject?

The Document.open() method opens a document for Document.write.

inherited

prepend(JSAny nodes) → void

The Document.prepend() method inserts a set of Node objects or string objects before the first child of the document. String objects are inserted as equivalent Text nodes.

inherited

queryCommandEnabled(String commandId) → bool

The Document.queryCommandEnabled() method reports whether or not the specified editor command is enabled by the browser.

inherited

queryCommandIndeterm(String commandId) → bool

inherited

queryCommandState(String commandId) → bool

The queryCommandState() method will tell you if the current selection has a certain Document.execCommand command applied.

inherited

queryCommandSupported(String commandId) → bool

The Document.queryCommandSupported() method reports whether or not the specified editor command is supported by the browser.

inherited

queryCommandValue(String commandId) → String

inherited

querySelector(String selectors) → Element?

The Document method querySelector() returns the first Element within the document that matches the specified selector, or group of selectors. If no matches are found, null is returned.

inherited

querySelectorAll(String selectors) → NodeList

The Document method querySelectorAll() returns a static (not live) NodeList representing a list of the document's elements that match the specified group of selectors.

inherited

releaseEvents() → void

inherited

removeChild(Node child) → Node

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

inherited

removeEventListener(String type, EventListener? callback, [JSAny options]) → void

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

inherited

replaceChild(Node node, Node child) → Node

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

inherited

replaceChildren(JSAny nodes) → void

The Document.replaceChildren() method replaces the existing children of a Document with a specified new set of children.

inherited

toString() → String

A string representation of this object.

inherited

write(String text) → void

Warning: Use of the document.write() method is strongly discouraged.

As the HTML spec itself warns:

This method has very idiosyncratic behavior. In some cases, this method can affect the state of the

HTML parser while the parser is running, resulting in a DOM that does not correspond to the source of the document (e.g. if the string written is the string "<plaintext>" or "<!--"). In other cases, the call can clear the current page first, as if document.open() had been called. In yet more cases, the method is simply ignored, or throws an exception. Users agents are explicitly allowed to avoid executing script elements inserted via this method. And to make matters even worse, the exact behavior of this method can in some cases be dependent on network latency, which can lead to failures that are very hard to debug. For all these reasons, use of this method is strongly discouraged.

Therefore, avoid using document.write() — and if possible, update any existing code that is still using it.

inherited

writeln(String text) → void

Warning: Use of the document.writeln() method is strongly discouraged.

As the HTML spec itself warns:

This method has very idiosyncratic behavior. In some cases, this method can affect the state of the

HTML parser while the parser is running, resulting in a DOM that does not correspond to the source of the document (e.g. if the string written is the string "<plaintext>" or "<!--"). In other cases, the call can clear the current page first, as if document.open() had been called. In yet more cases, the method is simply ignored, or throws an exception. Users agents are explicitly allowed to avoid executing script elements inserted via this method. And to make matters even worse, the exact behavior of this method can in some cases be dependent on network latency, which can lead to failures that are very hard to debug. For all these reasons, use of this method is strongly discouraged.

Therefore, avoid using document.writeln() — and if possible, update any existing code that is still using it.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited