matlab.io.xml.dom.Text Class

Namespace: matlab.io.xml.dom

Text in an XML document

Since R2021a

Description

An object of the matlab.io.xml.dom.Text class represents the text content of an XML document.

The matlab.io.xml.dom.Text 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.Text object by using the createTextNode method of a matlab.io.xml.dom.Document object.

Properties

Length — Number of characters in text

double

Number of characters in the text content of this node, specified as a double.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

TextContent — Text content of text node

character vector

Text content of this text node, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Methods

Public Methods

appendData	appendData(thisText,characters) appends characters to the end of the text in this text node. Specify characters as character vectors or string scalars.
cloneNode	docClone = cloneNode(thisText,deep) creates and returns a copy of this matlab.io.xml.dom.Text object. If deep is true, the copy is a deep copy. If deep is false, the copy is a shallow copy.
compareDocumentPosition	posEnum = compareDocumentPosition(textNode,otherNode) returns a double value that encodes the position of a node relative to the position of this text node in the document that owns the nodes. To decode the returned value, posEnum, use the MATLAB expression bitor(posEnum,POSITION_ENUM) == posEnum, where POSITION_ENUM is one of these Text methods: DOCUMENT_POSITION_FOLLOWING — The other node follows this text node. DOCUMENT_POSITION_PRECEDING — The other node precedes this text node. DOCUMENT_POSITION_CONTAINED_BY — This text node contains the other node, which also follows this node. DOCUMENT_POSITION_CONTAINS — The other node contains this text 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); text = createTextNode(d,"Hello"); appendChild(root,text); pos = compareDocumentPosition(text,root); if bitor(pos,text.DOCUMENT_POSITION_CONTAINS) == pos disp("root contains text"); else disp("root does not contain text"); end
deleteData	deleteData(thisText,offset,count) deletes a range of characters from the text in this node. 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	name = getBaseURI(thisText) returns the base URI of this text node as a character vector. If the base URI is not known, the method returns an empty character array. The base URI of a text node is the URI of the document that owns the text node.
getData	data = getData(thisText) returns the character data in this node as a character vector.
getLength	count = getLength(thisText) returns the number of characters in the text content in this text node as a double.
getNextSibling	getNextSibling(thisText) returns the node that follows this text node in the child list of the parent node of this text node.
getNodeName	name = getNodeName(thisText) returns '#text'.
getNodeType	type = getNodeType(thisText) returns the double 3, which indicates that this node is a text node. This method provides compatibility with existing MATLAB® code that is based on the W3C XML DOM standard. For new MATLAB code, use isa to determine the type of a node. For example: import matlab.io.xml.dom.* d = Document('book'); para = createElement(d,"para"); txt = createTextNode(d,"hello"); if isa(txt,'matlab.io.xml.dom.Text') fprintf('This is a text node.\n'); end
getNodeTypeName	name = getNodeTypeName(thisText) returns 'TEXT_NODE'.
getNodeValue	value = getNodeValue(thisText) returns the text content of this text node as a character vector.
getOwnerDocument	doc = getOwnerDocument(thisText) returns the document that owns this text node as a matlab.io.xml.dom.Document object. The owner document is the document that created or imported this text node.
getParentNode	parent = getParentNode(thisText) returns the parent node of this text node. If this text node does not have a parent, the method returns an empty node.
getPreviousSibling	getPreviousSibling(thisText) returns the node that precedes this text node in the child list of the parent node of this text node. If no node precedes this text node, the method returns an empty node.
getTextContent	getTextContent(thisText) returns the text content of this text node as a character vector.
insertData	insertData(thisText,index,data) inserts characters at the position specified by the zero-based index argument. Specify index as an integer and data as a character vector or string scalar.
isEqualNode	tf = isEqualNode(thisText,otherNode) returns true if the node specified by otherNode is a text node and has the same text content as this text node. 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(thisText,otherNode) returns true if otherNode is the same node as thisText.
replaceData	replaceData(thisText,index,count,data) replaces the number of characters specified by count in the text content of this text 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(thisText,data) replaces the current content of this text node with the text specified by data. Specify data as a character vector or string scalar.
setNodeValue	setNodeValue(thisText,value) sets the text content of this text node to the text specified by value. Specify value as a character vector or string scalar.
setTextContent	setTextContent(thisElem,textContent) sets the text content in this text node to the text specified by textContent. Specify textContent as a character vector or string scalar.
splitText	newNode = splitText(thisText,index) splits this text node into two text nodes at the specified zero-based index and returns the new text node. After the split, the original text 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 text node has a parent, the method inserts the new text node after this text node in the parent node.
substringData	substringData(thisText,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 Text Node for an XML DOM Document

Create a text node to append to a document element by using the createTextNode method of the matlab.io.xml.dom.Document object that represents the document.

Import the matlab.io.xml.dom package so that you do not have to use long, fully qualified class names.

import matlab.io.xml.dom.*

Create a document with a root element named employee.

doc = Document("employee");
employeeElem = getDocumentElement(doc);

Create an element named jobtitle.

jobtitleElem = createElement(doc,"jobtitle");

Create a text node for the jobtitle text content and append the text note to the jobtitle element.

textNode = createTextNode(doc,"Manager");
appendChild(jobtitleElem,textNode);

Append the jobtitle element to the employeeElem element.

appendChild(employeeElem,jobtitleElem);

Write the XML to a file.

xmlFileName = "employee.xml";
writer = matlab.io.xml.dom.DOMWriter;
writeToFile(writer,doc,xmlFileName);

Version History

Introduced in R2021a