Table of Contents

xmlDoc.loaded

Description

The loaded property returns a Boolean value indicating whether a previously invoked load( ) or sendAndLoad( ) operation on xmlDoc has completed. The specified xmlDoc must be the top-level node in an XML object hierarchy (i.e., an instance of the XML class, not the XMLnode class).

The loaded property is immediately set to false when an XML load( ) or sendAndLoad( ) operation is initiated. If the load is successful, loaded is set to true; otherwise, it remains false. If no such operation has ever been executed on xmlDoc, loaded is undefined.

When loaded is false, the download and parsing of XML data is still in progress and attempts to access the object hierarchy in xmlDoc will fail. When loaded is true, XML data has finished being downloaded, parsed, and stored in xmlDoc as an object hierarchy. Note, however, that the loaded XML data may not have been parsed successfully (check the status property to determine if parsing was successful).

Example

The following example shows a basic XML preloader that waits for the XML data to be loaded before displaying it (XML preloaders can also be built using an XML.onLoad( ) handler or XML.getBytesLoaded( ) and XML.getBytesTotal( )):

// CODE ON FRAME 1
// Create a new XML document.
myDoc = new XML();
// Load an external XML file into the document.
myDoc.load("userProfile.xml");
   
// CODE ON FRAME 5
// If the data has loaded, go to the display frame.
// If not, loop back to frame 4 and then play.
// Loop until the data is done loading...
if (myDoc.loaded) {
  if (myDoc.status =  = 0) {
    gotoAndStop("displayData");
  } else {
    gotoAndStop("loadingError");
  }
} else {
  gotoAndPlay(4);
}

See Also

XML.load( ), XML.onLoad( ), XML.sendAndLoad( ), XML.status

Table of Contents