XMLDocument Property

Retrieves a reference to the XML Document Object Model (DOM) exposed by the object.

Syntax

XML N/A
Scripting [ oXMLObject = ] object.XMLDocument

Possible Values

oXMLObject Object that specifies the XML DOM exposed by the object.
The property is read-only. The property has no default value.

Remarks

For a complete description of the XML DOM exposed by the XMLDocument property, see the XML DOM Reference.
When persistence is applied to an element, a root node is automatically created within the exposed XML document. This node is accessed through the documentElement property. You can use setAttribute to add attributes to the root node, and you can use appendChild to add child nodes to the root node.
The XMLDocument property is available to the saveFavorite and saveHistory behaviors only when the onload and onsave events are fired.

Example

This example shows how a persistent object can access the XML DOM through the XMLDocument property. The setAttribute method is exposed through the XML DOM. The setAttribute method is not the same as the DHTML and persistence methods of the same name.
<HTML>
<HEAD>
<META NAME="save" CONTENT="history">
<STYLE>
.saveHistory {behavior:url(#default#savehistory);}
</STYLE>
<SCRIPT>
function fnSave(){
var oXMLDoc=oPersistObject.XMLDocument;
var oNode=oXMLDoc.createNode(1,"Trunk", "");
oNode.text="A tree trunk.";
oNode.setAttribute("desc",oPersistObject.innerHTML);
oXMLDoc.documentElement.insertBefore(oNode, null);
}
function fnLoad(){
var oXMLDoc=oPersistObject.XMLDocument;
var oItem=oXMLDoc.documentElement.childNodes.item(1);
oPersistObject.innerHTML=oItem.getAttribute("desc");
}
function fnInsTxt(){
oPersistObject.innerHTML="I am an Ash.  I am an Ash sapling."
+ "Well, I am the trunk of an Ash sapling.";
}
</SCRIPT>
</HEAD>
<BODY>
<INPUT TYPE="button" VALUE="Insert Text" ONCLICK="fnInsTxt()">
<A HREF="/workshop/samples/author/persistence/saveTarget_1.htm">
Leave The Page
</A>
<DIV
ID="oPersistObject"
CLASS="saveHistory"
ONSAVE="fnSave()"
ONLOAD="fnLoad()">
</DIV>
</BODY>
</HTML>
This feature requires Microsoft® Internet Explorer 5 or later. Click the following icon to install the latest version. Then reload this page to view the sample.

Standards Information

There is no public standard that applies to this property.

Applies To

saveFavorite, saveHistory, userData