User Guide

1034 Chapter 2: ActionScript Language Reference
XML.load()
Availability
Flash Player 5; behavior changed in Flash Player 7.
Usage
my_xml.load(url:String) : Void
Parameters
url
A string that represents the URL where the XML document to be loaded is located. If the
SWF file that issues this call is running in a web browser,
url must be in the same domain as the
SWF file; for details, see the Description section.
Returns
Nothing.
Description
Method; loads an XML document from the specified URL, and replaces the contents of the
specified XML object with the downloaded XML data. The URL is relative and is called using
HTTP. The load process is asynchronous; it does not finish immediately after the
load() method
is executed.
In SWF files running in a version of the player earlier than Flash Player 7, the
url parameter must
be in the same superdomain as the SWF file that issues this call. A superdomain is derived by
removing the leftmost component of a file’s URL. For example, a SWF file at
www.someDomain.com can load data from sources at store.someDomain.com, because both files
are in the same superdomain of someDomain.com.
In SWF files of any version running in Flash Player 7 or later, the
url parameter must be in
exactly the same domain (see “Flash Player security features” in Using ActionScript in Flash). For
example, a SWF file at www.someDomain.com can load data only from sources that are also at
www.someDomain.com. If you want to load data from a different domain, you can place a cross-
domain policy file on the server that is hosting the SWF file. For more information, see “About
allowing cross-domain data loading” in Using ActionScript in Flash.
When the
load() method is executed, the XML object property loaded is set to false. When
the XML data finishes downloading, the
loaded property is set to true, and the onLoad event
handler is invoked. The XML data is not parsed until it is completely downloaded. If the XML
object previously contained any XML trees, they are discarded.
You can define a custom function that executes when the
onLoad event handler of the XML
object is invoked.
Example
The following simple example uses the XML.load() method:
// create a new XML object
var flooring:XML = new XML();
// set the ignoreWhite property to true (default value is false)