matlab.io.xml.dom.CDATASection Class

Namespace: matlab.io.xml.dom

CDATA section

Since R2021a

Description

An object of the matlab.io.xml.dom.CDATASection class defines an XML CDATA section. A CDATA section contains text content that is serialized without escaping XML markup characters.

A matlab.io.xml.dom.Parser object converts the markup <![CDATA[...]]> to a CDATASection object. You can use unescaped characters in the CDATA section markup. For example, you can use > instead of >. CDATA section markup facilitates inclusion of computer code and mathematical expressions in XML documents by eliminating the need to use character entities to indicate >, <, and other characters.

The matlab.io.xml.dom.CDATASection class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Create a matlab.io.xml.dom.CDATASection object by using the createCDATASection method of a matlab.io.xml.dom.Document object.

Properties

Length — Number of characters in CDATA section

double

Number of characters in the CDATA section, specified as a double.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

TextContent — Text content of CDATA section

character vector

Text content of the CDATA section, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

appendData	appendData(thisCDATASection,characters) appends characters to the end of the character data in this CDATA section. Specify characters as a character vector or string scalar.
cloneNode	copy = cloneNode(thisCDATASection,deep) creates a copy of this CDATA section and returns the copy. If deep is true, the copy is a deep copy. If deep is false, the copy is a shallow copy.
compareDocumentPosition	posEnum = compareDocumentPosition(thisCDATASection,otherNode) returns a double value that encodes the position of otherNode relative to the position of thisCDATASection in the document that owns thisCDATASection. To decode the returned value, posEnum, use the MATLAB expression bitor(posEnum,POSITION_ENUM) == posEnum, where POSITION_ENUM is one of these Comment methods: DOCUMENT_POSITION_FOLLOWING — The other node follows this CDATA section node. DOCUMENT_POSITION_PRECEDING — The other node precedes this CDATA section node. DOCUMENT_POSITION_CONTAINED_BY — This CDATA section node contains the other node, which also follows this node. DOCUMENT_POSITION_CONTAINS — The other node contains this CDATA section node and also precedes this node. DOCUMENT_POSITION_DISCONNECTED — The two nodes are disconnected. For example: import matlab.io.xml.dom.* d = Document("root"); root = getDocumentElement(d); cdata = createCDATASection(d,... "Example of a CDATA section"); appendChild(root,cdata); pos = compareDocumentPosition(cdata,root); if bitor(pos,cdata.DOCUMENT_POSITION_CONTAINS)... == pos disp("root contains CDATA section"); else disp("root does not contain CDATA section"); end
deleteData	deleteData(thisCDATASection,offset,count) deletes a range of characters from the text in this CDATA section. The offset argument is the zero-based index of the first character to delete, specified as an integer. The count argument is the number of characters to delete, specified as an integer.
getBaseURI	uri = getBaseURI(thisCDATASection) returns the base URI of this CDATA section as a character vector. The base URI is the URI of the document that owns this CDATA section.
getData	str = getData(thisCDATASection) returns the character data in this CDATA section as a character vector.
getLength	count = getLength(thisCDATASection) returns the number of characters in this CDATA section as a double.
getNextSibling	sibling = getNextSibling(thisCDATASection) returns the node that follows this CDATA section in the child list of the parent of this CDATA section node.
getNodeName	name = getNodeName(thisCDATASection) returns '#cdata-section'.
getNodeTypeName	name = getNodeTypeName(thisCDATASection) returns 'CDATA_SECTION_NODE'.
getNodeValue	value = getNodeValue(thisCDATASection) returns the content of this CDATA section as a character vector.
getOwnerDocument	doc = getOwnerDocument(thisCDATASection) returns the document that owns this CDATA section as a matlab.io.xml.dom.Document object. The owner document is the document that created or imported this CDATA section.
getParentNode	parent = getParentNode(thisCDATASection) returns the parent of this CDATA section. If this CDATA section does not have a parent, the method returns an empty node.
getPreviousSibling	sibling = getPreviousSibling(thisCDATASection) returns the node that precedes this CDATA section in the child list of the parent of this CDATA section.
getTextContent	text = getTextContent(thisCDATASection) returns the character data in this CDATA section as a character vector.
insertData	insertData(thisCDATASection,index,data) inserts character data at the position specified by the zero-based index argument. Specify data as a character vector or string scalar.
isEqualNode	tf = isEqualNode(thisCDATASection,otherNode) returns true if the node specified by otherNode is a CDATASection node and has the same content as thisCDATASection. This method tests for equality of nodes, not whether the nodes are handles to the same object. To test for sameness, use the isSameNode method. Nodes that are the same are also equal, but nodes that are equal are not necessarily the same. Normalize documents before testing them for equality because normalization can affect equality.
isSameNode	tf = isSameNode(thisCDATASection,otherNode) returns true if otherNode is the same node as thisCDATASection.
replaceData	replaceData(thisCDATASection,index,count,data) replaces the number of characters specified by count in the text content of this CDATA section node, starting at the position specified by the zero-based index, with the characters specified by data. Specify index and count as integers. Specify data as a character vector or string scalar.
setData	setData(thisCDATASection,data) replaces the current content of this CDATA section node with the text specified by data. Specify data as a character vector or string scalar.
setNodeValue	setNodeValue(thisCDATASection,value) sets the text content of this CDATA section node to the text specified by value. Specify value as a character vector or string scalar.
setTextContent	setTextContent(thisCDATASection,textContent) sets the text content of this CDATA section node to the text specified by textContent. Specify textContent as a character vector or string scalar.
splitText	newNode = splitText(thisCDATASection,index) splits this CDATASection node into two CDATASection nodes at the specified zero-based index and returns the new CDATASection node. After the split, the original node contains the original text up to the index. The new node contains the original text from the index. If the index equals the length of the original text, the new node is empty. If this CDATASection node has a parent, the method inserts the new node after this CDATASection node in the parent node.
substringData	substringData(thisCDATASection,index,count) returns the characters specified by index and count. Index is the zero-based position of the first character to return and count is the number of characters to return. Specify index and count as integers.

Examples

Create a CDATA Section to Output Unescaped Markup Characters

This example shows the difference between the serialized output from markup characters in a Text node and CDATASection node. The example creates a Text node and CDATASection node with text content that includes the markup characters > and <. The output from the Text node represents the markup characters as entities. The output from the CDATASection node includes the unescaped markup characters.

Create a Document object and get the root element.

import matlab.io.xml.dom.*

docNode = Document("root_element");
docRootNode = getDocumentElement(docNode);

Create a Text node that contains the code x > 1 | x < 2. Append the node to the root element.

tn = createTextNode(docNode,'x > 1 | x < 2');
appendChild(docRootNode,tn);

Create a CDATASection node that contains the same code and append the node to the root element.

cdata = createCDATASection(docNode,'x > 1 | x < 2');
appendChild(docRootNode,cdata);

Write the XML to a string.

str = writeToString(DOMWriter,docNode)

str = 
'<?xml version="1.0" encoding="UTF-16" standalone="no" ?><root_element>x &gt; 1 | x &lt; 2<![CDATA[x > 1 | x < 2]]></root_element>'

Version History

Introduced in R2021a