MACROMEDIA FLASH 8-ACTIONSCRIPT 2.0 LANGUAGE, Reference

Page: 1255 / 1378

TextSnapshot 1255
getSelected (TextSnapshot.getSelected method)
public getSelected(start:Number, [end:Number]) : Boolean
Returns a Boolean value that specifies whether a TextSnapshot object contains selected text in
the specified range.
To search all characters, pass a value of
0
for
start
, and
TextSnapshot.getCount()
(or any
very large number) for
end
. To search a single character, pass the
end
parameter a value that is
one greater than the
start
parameter.
Availability: ActionScript 1.0; Flash Player 7 - The SWF file must be published for Flash
Player 6 or later, and must be played in Flash Player 7 or later.
Parameters
start :Number
- The index position of the first character to be examined. Valid values for
start
are
0
through
TextSnapshot.getCount() - 1
. If
start
is a negative value,
0
is used.
end :Number
[optional] - The index position that is one greater than the last character to be
examined. Valid values for
end
are
0
through
TextSnapshot.getCount()
. The character
indexed by the
end
parameter is not included in the extracted string. If you omit this
parameter,
TextSnapshot.getCount()
is used. If the value of
end
is less than or equal to the
value of
start
,
start + 1
is used.
Returns
Boolean
- A Boolean value that indicates whether at least one character in the given range has
been selected by the corresponding
TextSnapshot.setSelected()
method (
true
);
otherwise,
false
.
Example
The following example illustrates how to use this method. To use this code, place a static text
field that contains the text "TextSnapshot Example" on the Stage. In the library, include the
font used by the static text field, and in Linkage options for the font, select Export for
ActionScript. Add the following ActionScript to Frame 1 of the Timeline:
var my_snap:TextSnapshot = this.getTextSnapshot();
var count:Number = my_snap.getCount();
my_snap.setSelected(0, 4, true);
my_snap.setSelected(1, 2, false);
var firstCharIsSelected:Boolean = my_snap.getSelected(0, 1);
var secondCharIsSelected:Boolean = my_snap.getSelected(1, 2);
trace(firstCharIsSelected); // true
trace(secondCharIsSelected); // false