ObjectXmlCharacterData

The XmlCharacterData interface providesXmlTextandXmlCommentCommon functions of nodes

XmlCharacterData isXmlTextandXmlCommentThe node's superinterface. Documents never contain XmlCharacterData nodes, they only containXmlTextnode sumXmlCommentnode. But since both nodes have similar functionality, these functions are defined here so thatXmlTextandXmlCommentIt can be inherited.

inheritance relationship

member properties

data

String, the text contained in this node

1
String XmlCharacterData.data;

---

length

Integer, the number of characters contained in this node

1
readonly Integer XmlCharacterData.length;

---

nodeType

Integer, returns the node type of the node

1
readonly Integer XmlCharacterData.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

1
readonly String XmlCharacterData.nodeName;

The nodeName of different objects will return different values:

• XmlElement:element name
• XmlAttr: attribute name
• XmlText: #text
• XmlCDATASection: #cdata-section
• XmlProcessingInstruction: Returns the specified target target
• XmlComment: #comment
• XmlDocument: #document
• XmlDocumentType: doctype name

---

nodeValue

String, returns the name of the node, according to its type

1
String XmlCharacterData.nodeValue;

The nodeName of different objects will return different values:

• XmlElement: null
• XmlAttr: attribute value
• XmlText: the content of the node
• XmlCDATASection: the content of the node
• XmlProcessingInstruction: Returns the specified content data
• XmlComment: annotation text
• XmlDocument: null
• XmlDocumentType: null

---

ownerDocument

XmlDocument, returns the root element of the node (XmlDocumentobject)

1
readonly XmlDocument XmlCharacterData.ownerDocument;

---

parentNode

XmlNode, can return the parent node of a node

1
readonly XmlNode XmlCharacterData.parentNode;

---

childNodes

XmlNodeList, returns the node list of the child nodes of the specified node

1
readonly XmlNodeList XmlCharacterData.childNodes;

---

children

XmlNodeList, returns the node list of the child element nodes of the specified node.

1
readonly XmlNodeList XmlCharacterData.children;

---

firstChild

XmlNode, returns the first child node of the node

1
readonly XmlNode XmlCharacterData.firstChild;

---

lastChild

XmlNode, returns the last child node of the node

1
readonly XmlNode XmlCharacterData.lastChild;

---

previousSibling

XmlNode, returns the node immediately preceding a node (at the same tree level). If there is no such node, then this property returns null.

1
readonly XmlNode XmlCharacterData.previousSibling;

---

nextSibling

XmlNode, returns the node immediately following an element (in the same tree level). If there is no such node, the attribute returns null.

1
readonly XmlNode XmlCharacterData.nextSibling;

---

firstElementChild

XmlNode, returns the first child element node of the node

1
readonly XmlNode XmlCharacterData.firstElementChild;

---

lastElementChild

XmlNode, returns the last child element node of the node

1
readonly XmlNode XmlCharacterData.lastElementChild;

---

previousElementSibling

XmlNode, returns the element node immediately preceding a node (at the same tree level). If there is no such node, then this property returns null.

1
readonly XmlNode XmlCharacterData.previousElementSibling;

---

nextElementSibling

XmlNode, returns the element node immediately following an element (in the same tree level). If there is no such node, the attribute returns null.

1
readonly XmlNode XmlCharacterData.nextElementSibling;

---

textContent

String, queries and sets the text of the selected element. When querying, returns the values ​​of all text nodes within the element node; when setting, deletes all child nodes and replaces them with a single text node.

1
String XmlCharacterData.textContent;

member function

substringData

Extract substring from node

1
2
String XmlCharacterData.substringData(Integer offset,
    Integer count);

Call parameters:

• offset: Integer, the position of the first character to be returned
• count: Integer, the number of characters in the substring to be returned

Return results:

• String, returns the extracted string

---

appendData

Append string to node

1
XmlCharacterData.appendData(String arg);

Call parameters:

• arg: String, the string to be appended to the node

---

insertData

Insert string into node

1
2
XmlCharacterData.insertData(Integer offset,
    String arg);

Call parameters:

• offset: Integer, the character position at which the string is to be inserted into the node
• arg: String, the string to be inserted

---

deleteData

Remove text from node

1
2
XmlCharacterData.deleteData(Integer offset,
    Integer count);

Call parameters:

• offset: Integer, the position of the first character to be deleted
• count: Integer, the number of characters to delete

---

replaceData

Replace the characters of the node with the specified string

1
2
3
XmlCharacterData.replaceData(Integer offset,
    Integer count,
    String arg);

Call parameters:

• offset: Integer, the character position of the node to be replaced
• count: Integer, the number of characters to replace
• arg: String, the string to be inserted

---

hasChildNodes

Query whether there are child nodes

1
Boolean XmlCharacterData.hasChildNodes();

Return results:

• Boolean, returns true if there are any child nodes, otherwise returns false

---

normalize

Merge adjacent Text nodes and delete empty Text nodes

1
XmlCharacterData.normalize();

This method will traverse all descendant nodes of the current node and normalize the document by deleting empty Text nodes and merging all adjacent Text nodes. This method is useful for simplifying the structure of the document tree after inserting or deleting nodes.

---

cloneNode

Creates an exact copy of the specified node

1
XmlNode XmlCharacterData.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 results:

• XmlNode, returns the copied node

This method will copy and return a copy of the node on which it was called. If the argument passed to it is true, it will also recursively copy all descendant nodes 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 an Element node is copied, all its properties will be copied.

---

lookupPrefix

Returns the prefix matching the specified namespace URI on the current node

1
String XmlCharacterData.lookupPrefix(String namespaceURI);

Call parameters:

• namespaceURI: String, specifies the matching namespace URI

Return results:

• String, returns the matching prefix, returns null if not matched.

---

lookupNamespaceURI

Returns the namespace URI matching the specified prefix on the current node

1
String XmlCharacterData.lookupNamespaceURI(String prefix);

Call parameters:

• prefix: String, specifies the matching prefix

Return results:

• String, returns the matching namespace URI, returns null if not matched.

---

insertBefore

Insert a new child node before an existing child node

1
2
XmlNode XmlCharacterData.insertBefore(XmlNode newChild,
    XmlNode refChild);

Call parameters:

• newChild:XmlNode, insert new node
• refChild:XmlNode, insert a new node before this node

Return results:

• XmlNode, returns the new child node

If newChild already exists in the document tree, it will be removed from the document tree and reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. That is, the ownerDocument attribute of newChild must be the same as the ownerDocument attribute of the current node.

---

insertAfter

Insert a new child node after an existing child node

1
2
XmlNode XmlCharacterData.insertAfter(XmlNode newChild,
    XmlNode refChild);

Call parameters:

• newChild:XmlNode, insert new node
• refChild:XmlNode, insert a new node after this node

Return results:

• XmlNode, returns the new child node

If newChild already exists in the document tree, it will be removed from the document tree and reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. That is, the ownerDocument attribute of newChild must be the same as the ownerDocument attribute of the current node.

---

appendChild

Adds a new child node to the end of a node's child node list

1
XmlNode XmlCharacterData.appendChild(XmlNode newChild);

Call parameters:

• newChild:XmlNode, specify the added node

Return results:

• XmlNode, returns this new child node

If newChild already exists in the document tree, it will be removed from the document tree and reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. That is, the ownerDocument attribute of newChild must be the same as the ownerDocument attribute of the current node.

---

replaceChild

Replace a child node with another

1
2
XmlNode XmlCharacterData.replaceChild(XmlNode newChild,
    XmlNode oldChild);

Call parameters:

• newChild:XmlNode, specify the new node
• oldChild:XmlNode, specifies the node to be replaced

Return results:

• 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 removed from the document tree and reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. That is, the ownerDocument attribute of newChild must be the same as the ownerDocument attribute of the current node.

---

removeChild

Remove a node from the list of child nodes

1
XmlNode XmlCharacterData.removeChild(XmlNode oldChild);

Call parameters:

• oldChild:XmlNode, specifies the node to be deleted

Return results:

• 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, "[Native Object]" is returned. The object can be re-implemented according to its own characteristics.

1
String XmlCharacterData.toString();

Return results:

• String, returns the string representation of the object

---

toJSON

Returns a JSON format representation of the object, generally returning a collection of readable properties defined by the object.

1
Value XmlCharacterData.toJSON(String key = "");

Call parameters:

• key: String, not used

Return results:

• Value, returns a value containing JSON serializable