TextSnapshot.getSelected()

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.getSelected(from, to)

Parameters

from An integer that indicates the position of the first character of my_snap to be examined. 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.

Returns

A Boolean value of true, if at least one character in the given range has been selected by the corresponding TextSnapshot.setSelected() command, false otherwise.

Description

Method; 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 from and TextSnapshot.getCount() (or any very large number) for to. To search a single character, pass a value of from+1 for to.

See also

TextSnapshot.getSelectedText(), TextSnapshot.getText()