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

mySnapshot.getSelectedText( [ includeLineEndings ] )

Parameters

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 that contains all the characters specified by the corresponding TextSnapshot.setSelected() command.

Description

Method; returns a string that contains all the characters specified by the corresponding TextSnapshot.setSelected() command. If no characters are selected, an empty string is returned.

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.

See also

TextSnapshot.getSelected()