Object XmlDocument
XmlDocument object represents the entire XML document
The XmlDocument object is the root of a document tree, which provides us with the initial (or topmost) access to the document data. For element nodes, text nodes, comments, processing instructions, etc., all cannot exist outside of XmlDocument, and the XmlDocument object also provides methods for creating these objects.XmlNode Objects provide an ownerDocument property that associates them with the XmlDocument in which they are created.
Inheritance
Constructor
XmlDocument
Construct an XmlDocument object
1new XmlDocument(String type = "text/xml");
Call parameters:
- type: String, specify the type of the document object, the default is "text/xml", if you need to process html, you need to specify "text/html"
Member attributes
inputEncoding
String, returns the encoding used for the document (when parsing)
1readonly String XmlDocument.inputEncoding;
xmlStandalone
Boolean, set or return whether the document is standalone
1Boolean XmlDocument.xmlStandalone;
xmlVersion
String, set or return the XML version of the document
1String XmlDocument.xmlVersion;
doctype
XmlDocumentType, Returns the document type declaration related to the document (Document Type Declaration)
1readonly XmlDocumentType XmlDocument.doctype;
For XML documents without DTD, null is returned. This attribute can provideXmlDocumentType Direct access to the object (a child node of XmlDocument).
documentElement
XmlElement, Return the root node of the document
1readonly XmlElement XmlDocument.documentElement;
head
XmlElement, Returns the head node of the HTML document, only valid in html mode
1readonly XmlElement XmlDocument.head;
title
String, returns the content of the title node of the HTML document, only valid in html mode
1readonly String XmlDocument.title;
body
XmlElement, Returns the body node of the HTML document, only valid in html mode
1readonly XmlElement XmlDocument.body;
nodeType
Integer, returns the node type of the node
1readonly Integer XmlDocument.nodeType;
The nodeType of different objects will return different values:
- XmlElement: ELEMENT_NODE(1)
- XmlAttr: ATTRIBUTE_NODE(2)
- XmlText: TEXT_NODE(3)
- XmlCDATASection: CDATA_SECTION_NODE(4)
- XmlProcessingInstruction: PROCESSING_INSTRUCTION_NODE(7)
- XmlComment: COMMENT_NODE(8)
- XmlDocument: DOCUMENT_NODE(9)
- XmlDocumentType: DOCUMENT_TYPE_NODE(10)
nodeName
String, returns the name of the node, according to its type
1readonly String XmlDocument.nodeName;
The nodeName of different objects will return different values:
- XmlElement: element name
- XmlAttr: Property name
- XmlText: #text
- XmlCDATASection: #cdata-section
- XmlProcessingInstruction: Return to the specified target
- XmlComment: #comment
- XmlDocument: #document
- XmlDocumentType: doctype name
nodeValue
String, returns the name of the node, according to its type
1String XmlDocument.nodeValue;
The nodeName of different objects will return different values:
- XmlElement: null
- XmlAttr: The value of the attribute
- XmlText: The content of the node
- XmlCDATASection: The content of the node
- XmlProcessingInstruction: Return the specified content data
- XmlComment: Comment text
- XmlDocument: null
- XmlDocumentType: null
ownerDocument
XmlDocument, returns the root element of the node (XmlDocument object)
1readonly XmlDocument XmlDocument.ownerDocument;
parentNode
XmlNode, Can return the parent node of a node
1readonly XmlNode XmlDocument.parentNode;
childNodes
XmlNodeList, Returns the node list of the child nodes of the specified node
1readonly XmlNodeList XmlDocument.childNodes;
firstChild
XmlNode, Return the first child node of the node
1readonly XmlNode XmlDocument.firstChild;
lastChild
XmlNode, Return the last child node of the node
1readonly XmlNode XmlDocument.lastChild;
previousSibling
XmlNode, Returns the node immediately before a certain node (at the same tree level), if there is no such node, then the attribute returns null
1readonly XmlNode XmlDocument.previousSibling;
nextSibling
XmlNode, Returns the node immediately following an element (in the same tree level), if there is no such node, the property returns null
1readonly XmlNode XmlDocument.nextSibling;
Member function
load
Compose the document by parsing an XML/HTML string, does not support multilingual
1XmlDocument.load(String source);
Call parameters:
- source: String, the XML/HTML text to be parsed, depending on the type of document when it was created
The document is composed by parsing a binary XML/HTML string, and automatically converted according to the language
1XmlDocument.load(Buffer source);
Call parameters:
- source: Buffer, The XML/HTML text to be parsed depends on the type of document when it was created
getElementsByTagName
Returns a node list of all elements with the specified name
1XmlNodeList XmlDocument.getElementsByTagName(String tagName);
Call parameters:
- tagName: String, the label name to be retrieved. The value "*" matches all tags
Return result:
- XmlNodeList, With the specified mark in the document tree XmlElement Nodal XmlNodeListgather. The order of returned element nodes is the order in which they appear in the source document.
This method will return a XmlNodeList Object (can be processed as a read-only array), the object stores all the documents with the specified tag name XmlElement Nodes, the order in which they are stored is the order in which they appear in the source document. XmlNodeList The object is "live", that is, if an element with the specified tag name is added or deleted in the document, its content will automatically be updated as necessary.
getElementsByTagNameNS
Returns a list of nodes with all elements of the specified namespace and name
1
2XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI,
String localName);
Call parameters:
- namespaceURI: String, specifies the namespace URI to retrieve. The value "*" can match all tags
- localName: String, the label name to be retrieved. The value "*" matches all tags
Return result:
- XmlNodeList, With the specified mark in the document tree XmlElement Nodal XmlNodeListgather. The order of returned element nodes is the order in which they appear in the source document.
This method is similar to the getElementsByTagName() method, except that it retrieves elements based on the namespace and name.
getElementById
Returns the element with the specified id attribute
1XmlElement XmlDocument.getElementById(String id);
Call parameters:
- id: String, id to be retrieved
Return result:
- XmlElement, The node tree with the specified id attribute XmlElement node
This method will traverse the descendant nodes of the document and return a XmlElementThe node object represents the first document element with the specified id attribute. .
getElementsByClassName
Returns a node list of all elements with the specified class name
1XmlNodeList XmlDocument.getElementsByClassName(String className);
Call parameters:
- className: String, the name of the class to be retrieved
Return result:
- XmlNodeList, With the specified class name in the document tree XmlElement Nodal XmlNodeListgather. The order of returned element nodes is the order in which they appear in the source document.
This method will return a XmlNodeList Object (can be processed as a read-only array), which stores all files with the specified class name in the document XmlElement Nodes, the order in which they are stored is the order in which they appear in the source document. XmlNodeList The object is "live", that is, if an element with the specified tag name is added or deleted in the document, its content will automatically be updated as necessary.
createElement
Create element node
1XmlElement XmlDocument.createElement(String tagName);
Call parameters:
- tagName: String, specify the specified name of the element node
Return result:
- XmlElement, Return the newly created XmlElement Node with specified label name
createElementNS
Create element node with specified namespace
1
2XmlElement XmlDocument.createElementNS(String namespaceURI,
String qualifiedName);
Call parameters:
- namespaceURI: String, specify the URI of the element node namespace
- qualifiedName: String, specify the specified name of the element node
Return result:
- XmlElement, Return the newly created XmlElement Node with specified label name
createTextNode
Create text node
1XmlText XmlDocument.createTextNode(String data);
Call parameters:
- data: String, specify the text of this node
Return result:
createComment
Create comment node
1XmlComment XmlDocument.createComment(String data);
Call parameters:
- data: String, specify the comment text of this node
Return result:
- XmlComment, Return the newly created XmlComment Node, the comment text is the specified data
createCDATASection
create XmlCDATASection node
1XmlCDATASection XmlDocument.createCDATASection(String data);
Call parameters:
- data: String, specify this node to specify CDATA data
Return result:
- XmlCDATASection, Return the newly created XmlCDATASection Node, the content is the specified data
createProcessingInstruction
create XmlProcessingInstruction node
1
2XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target,
String data);
Call parameters:
- target: String, specify the target of the processing instruction
- data: String, specify the content text of the processing instruction
Return result:
- XmlProcessingInstruction, The newly created ProcessingInstruction node
hasChildNodes
Query whether there are child nodes
1Boolean XmlDocument.hasChildNodes();
Return result:
- Boolean, Return true if there are any child nodes, otherwise return false
normalize
Merge adjacent Text nodes and delete empty Text nodes
1XmlDocument.normalize();
This method will traverse all descendant nodes of the current node, and normalize the document by deleting the empty Text node and merging all adjacent Text nodes. This method is useful for simplifying the structure of the document tree after inserting or deleting nodes.
cloneNode
Create an exact copy of the specified node
1XmlNode XmlDocument.cloneNode(Boolean deep = true);
Call parameters:
- deep: Boolean, whether to deep copy, when true, the cloned node will clone all child nodes of the original node
Return result:
- XmlNode, Return the copied node
This method will copy and return a copy of the node that called it. If the parameter passed to it is true, it will also recursively copy all descendants of the current node. Otherwise, it only copies the current node. The returned node does not belong to the document tree, and its parentNode property is null. When the Element node is copied, all its attributes will be copied.
lookupPrefix
Returns the prefix matching the specified namespace URI on the current node
1String XmlDocument.lookupPrefix(String namespaceURI);
Call parameters:
- namespaceURI: String, specify the matching namespace URI
Return result:
- String, Returns the matched prefix, returns null if it is not matched
lookupNamespaceURI
Returns the namespace URI that matches the specified prefix on the current node
1String XmlDocument.lookupNamespaceURI(String prefix);
Call parameters:
- prefix: String, specify the matching prefix
Return result:
- String, Returns the matching namespace URI, returns null if it is not matched
insertBefore
Insert a new child node before the existing child node
1
2XmlNode XmlDocument.insertBefore(XmlNode newChild,
XmlNode refChild);
Call parameters:
Return result:
- XmlNode, Return the new child node
If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.
insertAfter
Insert a new child node after the existing child node
1
2XmlNode XmlDocument.insertAfter(XmlNode newChild,
XmlNode refChild);
Call parameters:
Return result:
- XmlNode, Return the new child node
If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.
appendChild
Add a new child node to the end of the node's child node list
1XmlNode XmlDocument.appendChild(XmlNode newChild);
Call parameters:
- newChild: XmlNode, Specify the added node
Return result:
- XmlNode, Return this new child node
If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.
replaceChild
Replace one child node with another
1
2XmlNode XmlDocument.replaceChild(XmlNode newChild,
XmlNode oldChild);
Call parameters:
Return result:
- XmlNode, If the replacement is successful, this method can return the replaced node, if the replacement fails, it returns null
If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.
removeChild
Remove a node from the list of child nodes
1XmlNode XmlDocument.removeChild(XmlNode oldChild);
Call parameters:
- oldChild: XmlNode, Specify the node to be deleted
Return result:
- XmlNode, If the deletion is successful, this method can return the deleted node, if it fails, it returns null
toString
Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics
1String XmlDocument.toString();
Return result:
- String, Returns the string representation of the object
toJSON
Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object
1Value XmlDocument.toJSON(String key = "");
Call parameters:
- key: String, unused
Return result:
- Value, Returns a value containing JSON serializable