ScrollPane.getBytesLoaded()

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX 2004.

Usage

scrollPaneInstance.getBytesLoaded()

Parameters

None.

Returns

The number of bytes loaded in the scroll pane.

Description

Method; returns the number of bytes loaded in the ScrollPane instance. You can call this method at regular intervals while loading content to check its progress.

Example

This example creates a ScrollPane instance called my_sp and defines a listener object called loadListener with a progress event handler. The event handler calls the getBytesLoaded() and getBytesTotal() functions to display the progress of the load in the Output panel.

You first drag the ScrollPane component from the Components panel to the current document's library and then add the following code to Frame 1:

/**
 Requires:
  - ScrollPane component in library
*/

this.createClassObject(mx.containers.ScrollPane, "my_sp", 10);
my_sp.setSize(360, 280);

var loadListener:Object = new Object();
loadListener.progress = function(evt_obj:Object) {
 trace(my_sp.getBytesLoaded() + " of " + my_sp.getBytesTotal() + " bytes loaded.");
};
my_sp.addEventListener("progress", loadListener);

System.security.allowDomain("http://www.helpexamples.com");
my_sp.contentPath = "http://www.helpexamples.com/flash/images/image1.jpg";