Class Comment
Stay organized with collections
Save and categorize content based on your preferences.
Comment
A representation of an XML Comment node.
Detailed documentation
detach()
Detaches the node from its parent Element node. If the node does not have a parent,
this method has no effect.
Return
Content — the detached node
getParentElement()
Gets the node's parent Element node. If the node does not have a parent, this method
returns null.
Return
Element — the parent Element node
getText()
Gets the text value of the Comment node.
Return
String — the text value of the Comment 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 Comment node.
Parameters
| Name | Type | Description |
text | String | the text value to set |
Return
Comment — the Comment node, for chaining
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eRepresents an XML \u003ccode\u003eComment\u003c/code\u003e node, providing methods for interaction.\u003c/p\u003e\n"],["\u003cp\u003eAllows detachment from parent element, retrieval of parent/text values, and text modification.\u003c/p\u003e\n"],["\u003cp\u003eIncludes \u003ccode\u003egetText()\u003c/code\u003e for the comment's text and \u003ccode\u003egetValue()\u003c/code\u003e for text of all child nodes.\u003c/p\u003e\n"],["\u003cp\u003eOffers \u003ccode\u003esetText()\u003c/code\u003e to modify the comment's text and \u003ccode\u003edetach()\u003c/code\u003e to remove it from its parent.\u003c/p\u003e\n"]]],["An XML `Comment` node can be manipulated using several methods. `detach()` removes the node from its parent element. `getParentElement()` retrieves the parent `Element` node, if any. `getText()` and `getValue()` return the text content of the `Comment` node and its children respectively. The `setText(text)` method updates the text content of the `Comment` node and supports method chaining by returning the updated `Comment` node.\n"],null,["# Class Comment\n\nComment\n\nA representation of an XML `Comment` node. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| [detach()](#detach()) | [Content](/apps-script/reference/xml-service/content) | Detaches the node from its parent [Element](/apps-script/reference/xml-service/element) node. |\n| [getParentElement()](#getParentElement()) | [Element](/apps-script/reference/xml-service/element) | Gets the node's parent [Element](/apps-script/reference/xml-service/element) node. |\n| [getText()](#getText()) | `String` | Gets the text value of the `Comment` node. |\n| [getValue()](#getValue()) | `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. |\n| [setText(text)](#setText(String)) | [Comment](#) | Sets the text value of the `Comment` node. |\n\nDetailed documentation\n----------------------\n\n### `detach()`\n\nDetaches the node from its parent [Element](/apps-script/reference/xml-service/element) node. If the node does not have a parent,\nthis method has no effect.\n\n#### Return\n\n\n[Content](/apps-script/reference/xml-service/content) --- the detached node\n\n*** ** * ** ***\n\n### `get``Parent``Element()`\n\nGets the node's parent [Element](/apps-script/reference/xml-service/element) node. If the node does not have a parent, this method\nreturns `null`.\n\n#### Return\n\n\n[Element](/apps-script/reference/xml-service/element) --- the parent `Element` node\n\n*** ** * ** ***\n\n### `get``Text()`\n\nGets the text value of the `Comment` node.\n\n#### Return\n\n\n`String` --- the text value of the `Comment` node\n\n*** ** * ** ***\n\n### `get``Value()`\n\nGets the text value of all nodes that are direct or indirect children of the node, in the order\nthey appear in the document.\n\n#### Return\n\n\n`String` --- the text value of all nodes that are direct or indirect children of the node\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text value of the `Comment` node.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------------|\n| `text` | `String` | the text value to set |\n\n#### Return\n\n\n[Comment](#) --- the `Comment` node, for chaining"]]
