User Guide

794 Chapter 7: ActionScript for Flash
TextSnapshot.getText()
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.getText(from:Number, to:Number [, includeLineEndings:Boolean ] ) :
String
Parameters
from
An integer that indicates the position of the first character of my_snap to be included in
the returned string. Valid values for
from are 0 through TextSnapshot.getCount() - 1. If from
is a negative value, 0 is used.
to An integer that is 1+ the index of the last character in my_snap to be examined. Valid values
for
to are 0 through TextSnapshot.getCount(). The character indexed by the to parameter is
not included in the extracted string. If this parameter is omitted,
TextSnapshot.getCount() is
used. If this value is less than or equal to the value of
from, from+1 is used.
includeLineEndings An optional Boolean value that specifies whether newline characters are
inserted into the returned string where appropriate. The default value is
false.
Returns
A string containing the characters in the specified range, or an empty string if no characters are
found in the specified range.
Description
Method; returns a string that contains all the characters specified by the from and to parameters.
If no characters are selected, an empty string is returned.
To return all characters, pass a value of 0 for
from and TextSnapshot.getCount() (or any very
large number) for
to. To return a single character, pass a value of from+1 for to.
If you pass a value of
true for includeLineEndings, newline characters are inserted in the string
returned where deemed appropriate. In this case, the return string might be longer than the input
range. If
includeLineEndings is false or omitted, the selected text is returned without any
characters added.
Example
The following example illustrates how you can output the number of characters in a specified
TextSnapshot object. 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);