Sample Entry For Most Actionscript Elements - MACROMEDIA FLASH MX 2004 - ACTIONSCRIPT Reference Manual

Sample entry for most ActionScript elements

The following sample dictionary entry explains the conventions used for all ActionScript
elements that are not classes.
Entry title
All entries are listed alphabetically. The alphabetization ignores capitalization, leading
underscores, and so on.
Availability
Unless otherwise noted, the Availability section tells which versions of Flash Player support the
element. This is not the same as the version of Flash used to author the content. For example, if
you use Macromedia Flash MX 2004 or Macromedia Flash MX Professional 2004 to create
content for Flash Player 6, you can use only ActionScript elements that are available to Flash
Player 6.
In a few cases, this section also indicates which version of the authoring tool supports an element.
For an example, see System.setClipboard().
Finally, if an element is supported only in ActionScript 2.0, that information is also noted in
this section.
Usage
This section provides correct syntax for using the ActionScript element in your code. The
required portion of the syntax is in
. Brackets (
code font
Parameters
This section describes any parameters listed in the syntax.
Returns
This section identifies what, if any, values the element returns.
Description
This section identifies the type of element (for example, operator, method, function, and so on)
and then describes how to use the element.
Example
This section provides a code sample demonstrating how to use the element.
See also
This section lists related ActionScript dictionary entries.
206 Chapter 12: ActionScript Dictionary
code font
) indicate optional parameters.
[]
, and the code that you provide is in
italicized