timeline.setFrameProperty()

Availability

Flash MX 2004.

Usage

timeline.setFrameProperty(property, value [, startFrameIndex [, endFrameIndex]])

Parameters

property

A string that specifies the name of the property to be modified. For a complete list of properties and values, see the Property summary for the Frame object.

You can’t use this method to set values for read-only properties such as frame.duration and frame.elements.

value

Specifies the value to which you want to set the property. To determine the appropriate values and type, see the Property summary for the Frame object.

startFrameIndex

A zero-based index that specifies the starting frame number to modify. If you omit startFrameIndex, the method uses the current selection. This parameter is optional.

endFrameIndex

A zero-based index that specifies the first frame at which to stop. The range of frames goes up to, but does not include, endFrameIndex. If you specify startFrameIndex but omit endFrameIndex, endFrameIndex defaults to the value of startFrameIndex. This parameter is optional.

Returns

Nothing.

Description

Method; sets the property of the Frame object for the selected frames.

Example

The following example assigns the ActionScript stop() command to the first frame of the top layer in the current document:

fl.getDocumentDOM().getTimeline().currentLayer = 0; 
fl.getDocumentDOM().getTimeline().setSelectedFrames(0,0,true); 
fl.getDocumentDOM().getTimeline().setFrameProperty("actionScript", "stop();");

The following example sets a motion tween from Frame 2 up to, but not including, Frame 5, of the current layer (remember that index values are different from frame number values):

var doc = fl.getDocumentDOM(); 
doc.getTimeline().setFrameProperty("tweenType","motion",1,4);