createEntityReference Method

Creates a new EntityReference object.

objXMLDOMEntityReference = oXMLDOMDocument.createEntityReference(name)

Parameters

name

String specifying the name of the entity referenced. This name is subsequently available as the new object's nodeName property.

Return Value

Object. Returns the new XMLDOMEntityReference object.

Remarks

Creating an entity reference with this method is the same as using createNode where the type parameter value is NODE_ENTITY_REFERENCE and no namespace is specified. You cannot specify a namespace within the name parameter.

Although this method creates the new object in the context of this document, it does not automatically add the new object to the document tree. In other words, although the ownerDocument property of the new node points to this document object, the parentNode property is set to Null. You must explicitly call one of the node insert methods—insertBefore, replaceChild, or appendChild—to add the new object.

The nodeType property has the value NODE_ENTITY_REFERENCE.

Example

The following example creates a new XMLDOMEntityReference object and appends it to an XMLDOMNode object:

Dim xmlDoc
Dim root
Dim MyEntity
Set xmlDoc = CreateObject("Msxml2.DOMDocument")
xmlDoc.async = False
xmlDoc.load("c:\books.xml")
Set root = xmlDoc.documentElement
Set MyEntity = xmlDoc.createEntityReference("newRef")
root.childNodes.item(0).appendChild MyEntity
MsgBox root.xml

See Also

Applies To: DOMDocument Object