InitialFrame Property

Sprite Control

Specifies the frame that the sprite displays when it becomes visible. Read/write at run time; write access is available at run time only when the sprite is stopped.

Syntax

HTML <PARAM NAME="InitialFrame" VALUE="nFrame">

Scripting spriteObj.InitialFrame [=nFrame]

HTML	<PARAM NAME="InitialFrame" VALUE="nFrame">
Scripting	spriteObj.InitialFrame [=nFrame]

Possible Values

nFrame
Integer expression specifying the frame that the sprite should seek to before starting playback. The value of the Frame property is a one-based index into the frame map. For example, if the frame map defines 10 frames, the Frame property value is 10 when the last frame in the frame map appears on the page. If the InitialFrame property is set to 0, the sprite will load the media but will display a blank frame until the Play method is invoked. If the InitialFrame property is set to –1 (or any number less than zero), the sprite will not load the media and will display a blank frame until the Play method is invoked, at which point it will begin media download and start playback after the media has been completely downloaded. The default value is 1.

Remarks

This property is scriptable, but if it is set from a script, only the initial frame of the sprite as it is set in the HTML persistence is changed. The current frame of the sprite is not changed.

Example

The following example sets an initial frame indicator on the page to the value of the InitialFrame property for the sprite named SpriteHorse.
document.MyForm.txtInitialFrame.value=SpriteHorse.InitialFrame