beautypg.com

Document.framerate, Document.getaligntodocument() – Adobe Extending Flash Professional CS5 User Manual

Page 124

background image

102

EXTENDING FLASH PROFESSIONAL

Document object

Last updated 5/2/2011

document.frameRate

Availability
Flash MX 2004.

Usage

document.frameRate

Description
Property; a float value that specifies the number of frames displayed per second when the SWF file plays; the default is
12. Setting this property is the same as setting the default frame rate in the Document Properties dialog box (Modify
> Document) in the FLA file.

Example
The following example sets the frame rate to 25.5 frames per second:

fl.getDocumentDOM().frameRate = 25.5;

document.getAlignToDocument()

Availability
Flash MX 2004.

Usage

document.getAlignToDocument()

Parameters
None.

Returns
A Boolean value:

true

if the preference is set to align the objects to the Stage;

false

otherwise.

Description
Method; identical to retrieving the value of the To Stage button in the Align panel. Gets the preference that can be used
for

document.align()

,

document.distribute()

,

document.match()

, and

document.space()

methods on the

document.

Example
The following example retrieves the value of the To Stage button in the Align panel. If the return value is

true

, the To

Stage button is active; otherwise, it is not.

var isAlignToDoc = fl.getDocumentDOM().getAlignToDocument();

fl.getDocumentDOM().align("left", isAlignToDoc);

See also

document.setAlignToDocument()

This manual is related to the following products: