Class EntityRef
Stay organized with collections
Save and categorize content based on your preferences.
EntityRef
A representation of an XML EntityReference 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
getName()
Gets the name of the EntityReference node.
Return
String — the name of the EntityReference 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
getPublicId()
Gets the public ID of the EntityReference node. If the node does not have a public ID,
this method returns null.
Return
String — the public ID of the EntityReference node, or null if it has none
getSystemId()
Gets the system ID of the EntityReference node. If the node does not have a system ID,
this method returns null.
Return
String — the system ID of the EntityReference node, or null if it has none
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
setName(name)
Sets the name of the EntityReference node.
Parameters
| Name | Type | Description |
name | String | the name to set |
Return
EntityRef — the EntityReference node, for chaining
setPublicId(id)
Sets the public ID of the EntityReference node.
Parameters
| Name | Type | Description |
id | String | the public ID to set |
Return
EntityRef — the EntityReference node, for chaining
setSystemId(id)
Sets the system ID of the EntityReference node.
Parameters
| Name | Type | Description |
id | String | the system ID to set |
Return
EntityRef — the EntityReference 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\u003e\u003ccode\u003eEntityRef\u003c/code\u003e represents an XML \u003ccode\u003eEntityReference\u003c/code\u003e node, providing methods to interact with and modify it within a document.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to get and set the name, public ID, and system ID of the entity reference.\u003c/p\u003e\n"],["\u003cp\u003eYou can detach the node from its parent, retrieve its text value, and access its parent element using provided methods.\u003c/p\u003e\n"],["\u003cp\u003eThis class facilitates working with external entities referenced within an XML document using Apps Script's XML Service.\u003c/p\u003e\n"]]],["The `EntityRef` represents an XML entity reference node. Key actions include: getting the node's name, parent element, public ID, system ID, and the text value of its children. It also allows detaching from its parent. You can set the node's name, public ID, and system ID. If the node doesn't have a parent, public ID, or system ID, methods will return null or have no effect.\n"],null,["# Class EntityRef\n\nEntityRef\n\nA representation of an XML `Entity``Reference` 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| [getName()](#getName()) | `String` | Gets the name of the `Entity``Reference` 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| [getPublicId()](#getPublicId()) | `String` | Gets the public ID of the `Entity``Reference` node. |\n| [getSystemId()](#getSystemId()) | `String` | Gets the system ID of the `Entity``Reference` 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| [setName(name)](#setName(String)) | [EntityRef](#) | Sets the name of the `Entity``Reference` node. |\n| [setPublicId(id)](#setPublicId(String)) | [EntityRef](#) | Sets the public ID of the `Entity``Reference` node. |\n| [setSystemId(id)](#setSystemId(String)) | [EntityRef](#) | Sets the system ID of the `Entity``Reference` 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``Name()`\n\nGets the name of the `Entity``Reference` node.\n\n#### Return\n\n\n`String` --- the name of the `Entity``Reference` 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``Public``Id()`\n\nGets the public ID of the `Entity``Reference` node. If the node does not have a public ID,\nthis method returns `null`.\n\n#### Return\n\n\n`String` --- the public ID of the `Entity``Reference` node, or `null` if it has none\n\n*** ** * ** ***\n\n### `get``System``Id()`\n\nGets the system ID of the `Entity``Reference` node. If the node does not have a system ID,\nthis method returns `null`.\n\n#### Return\n\n\n`String` --- the system ID of the `Entity``Reference` node, or `null` if it has none\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``Name(name)`\n\nSets the name of the `Entity``Reference` node.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `name` | `String` | the name to set |\n\n#### Return\n\n\n[EntityRef](#) --- the `Entity``Reference` node, for chaining\n\n*** ** * ** ***\n\n### `set``Public``Id(id)`\n\nSets the public ID of the `Entity``Reference` node.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------------|\n| `id` | `String` | the public ID to set |\n\n#### Return\n\n\n[EntityRef](#) --- the `Entity``Reference` node, for chaining\n\n*** ** * ** ***\n\n### `set``System``Id(id)`\n\nSets the system ID of the `Entity``Reference` node.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------------|\n| `id` | `String` | the system ID to set |\n\n#### Return\n\n\n[EntityRef](#) --- the `Entity``Reference` node, for chaining"]]
