Class EntityRef

  • 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.

Entity Ref

A representation of an XML Entity Reference node.

Methods

Method Return type Brief description
Content |null Detaches the node from its parent Element node.
String Gets the name of the Entity Reference node.
Element |null Gets the node's parent Element node.
String|null Gets the public ID of the Entity Reference node.
String|null Gets the system ID of the Entity Reference 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 Ref Sets the name of the Entity Reference node.
Entity Ref Sets the public ID of the Entity Reference node.
Entity Ref Sets the system ID of the Entity Reference 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 |null — The detached node.


get Name()

Gets the name of the Entity Reference node.

Return

String — The name of the Entity Reference node.


get Parent Element()

Gets the node's parent Element node. If the node does not have a parent, this method returns null .

Return

Element |null — The parent Element node.


get Public Id()

Gets the public ID of the Entity Reference node. If the node does not have a public ID, this method returns null .

Return

String|null — The public ID of the Entity Reference node, or null if it has none.


get System Id()

Gets the system ID of the Entity Reference node. If the node does not have a system ID, this method returns null .

Return

String|null — The system ID of the Entity Reference 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 Reference node.

Parameters

Name Type Description
name
String The name to set.

Return

Entity Ref — The Entity Reference node, for chaining.


set Public Id(id)

Sets the public ID of the Entity Reference node.

Parameters

Name Type Description
id
String The public ID to set.

Return

Entity Ref — The Entity Reference node, for chaining.


set System Id(id)

Sets the system ID of the Entity Reference node.

Parameters

Name Type Description
id
String The system ID to set.

Return

Entity Ref — The Entity Reference node, for chaining.

Design a Mobile Site
View Site in Mobile | Classic
Share by: