ActionScript element documentation conventions

The following table explains the conventions used for Flash Remoting-related ActionScript objects. Objects are listed alphabetically with all other elements in the dictionary.

Label

Description

Entry title
The entry title provides the name of the object or component. The object or component name is followed by a paragraph that contains general descriptive information.

Method and property table
Each object and component entry contains a table listing all of the associated methods. If the object or component has properties (often constants), These elements are summarized in an additional table. All of the methods and properties listed in these tables also have their own dictionary entries, which follow the object or component entry.

Constructor
If an object or component requires you to use a constructor to access its methods and properties, the constructor is described in each object or component entry. This description has all of the standard elements (syntax, description, and so on) of other dictionary entries.

Method and property listings
The methods and properties of an object or component are listed alphabetically after the object or component entry.

Label	Description
Entry title	The entry title provides the name of the object or component. The object or component name is followed by a paragraph that contains general descriptive information.
Method and property table	Each object and component entry contains a table listing all of the associated methods. If the object or component has properties (often constants), These elements are summarized in an additional table. All of the methods and properties listed in these tables also have their own dictionary entries, which follow the object or component entry.
Constructor	If an object or component requires you to use a constructor to access its methods and properties, the constructor is described in each object or component entry. This description has all of the standard elements (syntax, description, and so on) of other dictionary entries.
Method and property listings	The methods and properties of an object or component are listed alphabetically after the object or component entry.

The following table explains the conventions used for all ActionScript methods and constructors:

Label

Description

Entry title
All entries are listed alphabetically. The alphabetization ignores capitalization, leading underscores, and so on.

Availability
This section tells which versions of the 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 the Flash MX authoring tool to create content for Flash Player 5, you can only use ActionScript elements that are available to Flash Player 5.

Usage
This section provides correct syntax for using the ActionScript element in your code. The required portion of the syntax is in code font, and the user provided code is in italicized code font. Brackets ([]) indicate optional parameters.

Parameters
This section describes any parameters listed in the syntax.

Return value
This section identifies what, if any, values the element returns.

Description
This section identifies the type of element (for example, an 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.

Label	Description
Entry title	All entries are listed alphabetically. The alphabetization ignores capitalization, leading underscores, and so on.
Availability	This section tells which versions of the 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 the Flash MX authoring tool to create content for Flash Player 5, you can only use ActionScript elements that are available to Flash Player 5.
Usage	This section provides correct syntax for using the ActionScript element in your code. The required portion of the syntax is in code font, and the user provided code is in italicized code font. Brackets ([]) indicate optional parameters.
Parameters	This section describes any parameters listed in the syntax.
Return value	This section identifies what, if any, values the element returns.
Description	This section identifies the type of element (for example, an 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.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flashremoting/mx/Using_Flash_Remoting_MX/asDict3.htm

Using Flash Remoting MX
Flash Remoting ActionScript Dictionary