MACROMEDIA FLASH MX 2004 - ACTIONSCRIPT - Page 505

MovieClip.getTextSnapshot() 505
MovieClip.getTextSnapshot()
Availability
Authoring: Flash MX 2004.
Playback: SWF files published for Flash Player 6 or later, playing in Flash Player 7 or later.
Usage
my_mc.getTextSnapshot();
Parameters
None.
Returns
A TextSnapshot object that contains the static text from my_mc, or an empty string if my_mc
contains no static text.
Description
Method; returns a TextSnapshot object that contains the text in all the static text fields in the
specified movie clip; text in child movie clips is not included.
Flash concatenates text and places it in the TextSnapshot object in an order that reflects the tab
index order of the static text fields in the movie clip. Text fields that don’t have tab index values
are placed in a random order in the object, and precede any text from fields that do have tab index
values. No line breaks or formatting indicates where one field ends and the next begins.
Note: You can’t specify a tab index value for static text in Flash. However, other products may do so;
for example, Macromedia FlashPaper.
The contents of the TextSnapshot object aren’t dynamic; that is, if the movie clip moves to a
different frame, or is altered in some way (for example, objects in the movie clip are added or
removed), the TextSnapshot object might not represent the current text in the movie clip. To
ensure that the object’s contents are current, reissue this command as needed.
See also
TextSnapshot object