C# Class SwfDotNet.IO.Tags.FrameLabelTag

FrameLabelTag defines a name for the current frame in a movie or movie clip.

The name can be referenced from other objects such as ActionGotoFrame2 to simplify the creation of scripts to control movies by using a predefined name rather than the frame number. The label assigned to a particular frame should be unique. Frames may also be reference externally when specifying the movie to play using a URL - similar to the way names links are used in HTML. When the Flash Player loaded a movie it will begin playing at the frame specified in the URL.

The name is assigned to a particular frame when the FrameLabelTag object is defined prior to the ShowFrameTag object that displays all the objects on the display list. The frame can then be referenced by its name once it has been defined. A frame cannot be referenced before the Player has loaded and displayed the frame that contains the corresponding FrameLabelTag object.

To start playing the movie at the frame labeled "StartHere" specify the label using the same format a HTML anchors:

http://www.mysite.com/flash/movie.swf#StartHere

This may be used either in a browser window to load a file or form within a movie using the ActionGetUrl or ActionGetUrl2 actions.

This tag was introduced in Flash 3. In Flash 6 the label can support named anchors which allows a frame to be specified as the starting point when displaying a Flash movie in a web browser.

Inheritance: BaseTag
Show file Open project: bladecoding/SwfExport Class Usage Examples

Public Methods

Method Description
FrameLabelTag ( ) : System

Creates a new FrameLabelTag instance.
FrameLabelTag ( string name ) : System

constructor.
GetSizeOf ( byte version ) : int

Gets the size of.
ReadData ( byte version, BufferedBinaryReader binaryReader ) : void

see base class
Serialize ( XmlWriter writer ) : void

Serializes the specified writer.
UpdateData ( byte version ) : void

see base class

Method Details

FrameLabelTag() public method

Creates a new FrameLabelTag instance.
public FrameLabelTag ( ) : System
return System

FrameLabelTag() public method

constructor.
public FrameLabelTag ( string name ) : System
name string label for frame
return System

GetSizeOf() public method

Gets the size of.
public GetSizeOf ( byte version ) : int
version byte
return int

ReadData() public method

see base class
public ReadData ( byte version, BufferedBinaryReader binaryReader ) : void
version byte
binaryReader SwfDotNet.IO.Utils.BufferedBinaryReader
return void

Serialize() public method

Serializes the specified writer.
public Serialize ( XmlWriter writer ) : void
writer System.Xml.XmlWriter Writer.
return void

UpdateData() public method

see base class
public UpdateData ( byte version ) : void
version byte
return void