MACROMEDIA FLEX-FLEX ACTIONSCRIPT LANGUAGE Reference page 793

Example
The following example illustrates how to use this method. To use this code, create a static text
field that contains the text "TextSnapshot Example".
// This example assumes that the movie clip contains
// the static text "TextSnapshot Example"
var my_mc:MovieClip = this;
var my_snap:TextSnapshot = my_mc.getTextSnapshot();
var count:Number = my_snap.getCount();
var theText:String = my_snap.getText(0, count, false);
trace(count); // output: 20
trace(theText); // output: TextSnapshot Example
See also
TextSnapshot.getSelectedText(),
TextSnapshot.getSelectedText()
Availability
Authoring: Flash MX 2004.
Playback: SWF files published for Flash Player 6 or later, playing in Flash Player 7 or later.
Usage
my_snap.getSelectedText( [ includeLineEndings:Boolean ] ) : String
Parameters
includeLineEndings
inserted into the returned string where appropriate. The default value is
Returns
A string that contains all the characters specified by the corresponding
TextSnapshot.setSelected()
Description
Method; returns a string that contains all the characters specified by the corresponding
TextSnapshot.setSelected()
returned.
If you pass a value of
returned where deemed appropriate. In this case, the return string might be longer than the input
range. If
includeLineEndings
characters added.
See also
TextSnapshot.getSelected()
TextSnapshot.getText()
An optional Boolean value that specifies whether newline characters are
command.
command. If no characters are selected, an empty string is
for
true includeLineEndings
is or omitted, the selected text is returned without any
false
false
, newline characters are inserted in the string
TextSnapshot.getSelectedText()
.
793