beautypg.com

Timeline.getguidelines() – Adobe Extending Flash Professional CS5 User Manual

Page 501

background image

479

EXTENDING FLASH PROFESSIONAL

Timeline object

Last updated 5/2/2011

endFrameIndex

A zero-based index that specifies the end of the range of frames to select. The range goes up to, but

does not include, endFrameIndex. If you specify only startFrameIndex, endFrameIndex defaults to the value of
startFrameIndex. This parameter is optional.

Returns
A value for the specified property, or

undefined

if all the selected frames do not have the same property value.

Description
Method; retrieves the specified property’s value for the selected frames.

Example
The following example retrieves the name of the first frame in the current document’s top layer and displays the name
in the Output panel:

fl.getDocumentDOM().getTimeline().currentLayer = 0;

fl.getDocumentDOM().getTimeline().setSelectedFrames(0, 0, true);

var frameName = fl.getDocumentDOM().getTimeline().getFrameProperty("name");

fl.trace(frameName);

timeline.getGuidelines()

Availability
Flash CS4 Professional.

Usage

timeline.getGuidelines()

Parameters
None.

Returns
An XML string.

Description
Method: returns an XML string that represents the current positions of the horizontal and vertical guide lines for a
timeline (View

> Guides

>Show Guides). To apply these guide lines to a timeline, use

timeline.setGuidelines()

.

Example
Assuming that you have some guide lines on the first timeline, the following example displays them as an XML string
in the Output panel:

var currentTimeline = fl.getDocumentDOM().timelines[0];
fl.trace(currentTimeline.getGuidelines());

This manual is related to the following products: