AI-generated Key Takeaways
-
EntityRef represents an XML EntityReference node.
-
It provides methods to get and set the name, public ID, and system ID of the node.
-
You can detach an EntityRef node from its parent element.
-
You can get the text value of all child nodes.
A representation of an XML Entity
node.
Methods
| Method | Return type | Brief description |
|---|---|---|
Content
|
Detaches the node from its parent Element
node. |
|
String
|
Gets the name of the Entity
node. |
|
Element
|
Gets the node's parent Element
node. |
|
String
|
Gets the public ID of the Entity
node. |
|
String
|
Gets the system ID of the Entity
node. |
|
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. | |
Entity
|
Sets the name of the Entity
node. |
|
Entity
|
Sets the public ID of the Entity
node. |
|
Entity
|
Sets the system ID of the Entity
node. |
Detailed documentation
detach()
get
Name()
Gets the name of the Entity
node.
Return
String
— the name of the Entity
node
get
Parent
Element()
get
Public
Id()
Gets the public ID of the Entity
node. If the node does not have a public ID,
this method returns null
.
Return
String
— the public ID of the Entity
node, or null
if it has none
get
System
Id()
Gets the system ID of the Entity
node. If the node does not have a system ID,
this method returns null
.
Return
String
— the system ID of the Entity
node, or null
if it has none
get
Value()
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
set
Name(name)
Sets the name of the Entity
node.
Parameters
| Name | Type | Description |
|---|---|---|
name
|
String
|
the name to set |
Return
Entity
— the Entity
node, for chaining
set
Public
Id(id)
Sets the public ID of the Entity
node.
Parameters
| Name | Type | Description |
|---|---|---|
id
|
String
|
the public ID to set |
Return
Entity
— the Entity
node, for chaining
set
System
Id(id)
Sets the system ID of the Entity
node.
Parameters
| Name | Type | Description |
|---|---|---|
id
|
String
|
the system ID to set |
Return
Entity
— the Entity
node, for chaining

