ActionScript: The Definitive Guide

Name

XML.loaded Property — status of a load( ) or sendAndLoad( ) operation

Availability

Flash 5

Synopsis

XMLdoc.loaded

Access

Read-only

Description

The loaded property returns a Boolean value indicating whether a previously invoked load( ) or sendAndLoad( ) operation on XMLdoc has completed. It is immediately set to false when an XML load( ) or sendAndLoad( ) operation is initiated. If the load is successful, loaded is later set to true. 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 (use XMLdoc .status to determine whether it was).

XMLdoc must be an instance of the XML class, not the XMLnode class.

Example

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

                     
// 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 // Check if the data has loaded. If so, 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 ...