Class Cdata
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
The Cdata object represents an XML
CDATASectionnode. -
Special characters are stored differently in
CDATASectionnodes compared to Text nodes. -
Methods are available to manipulate Cdata nodes, such as appending text, detaching from a parent, getting the parent element, and getting or setting the text value.
A representation of an XML CDATASection node.
// Create and log an XML document that shows how special characters like '<', // '>', and '&' are stored in a CDATASection node as compared to in a Text node. constillegalCharacters='<em>The Amazing Adventures of Kavalier & Clay</em>'; constcdata=XmlService.createCdata(illegalCharacters); consttext=XmlService.createText(illegalCharacters); constroot= XmlService.createElement('root').addContent(cdata).addContent(text); constdocument=XmlService.createDocument(root); constxml=XmlService.getPrettyFormat().format(document); Logger.log(xml);
Methods
| Method | Return type | Brief description |
|---|---|---|
append(text) | Text | Appends the given text to any content that already exists in the node. |
detach() | Content | Detaches the node from its parent Element node. |
get | Element | Gets the node's parent Element node. |
get | String | Gets the text value of the Text node. |
get | String | Gets the text value of all nodes that are direct or indirect children of the node, in the order they appear in the document. |
set | Text | Sets the text value of the Text node. |
Detailed documentation
append(text)
Appends the given text to any content that already exists in the node.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | the text to append to the node |
Return
Text — the Text node, for chaining
detach()
getParentElement()
getText()
Gets the text value of the Text node.
Return
String — the text value of the Text node
getValue()
Gets the text value of all nodes that are direct or indirect children of the node, in the order they appear in the document.
Return
String — the text value of all nodes that are direct or indirect children of the node
setText(text)
Sets the text value of the Text node.
Parameters
| Name | Type | Description |
|---|---|---|
text | String | the text value to set |
Return
Text — the Text node, for chaining