Flash MX 2004 --

TextSnapshot object

Availability

Authoring: Flash MX 2004.

Playback: SWF files published for Flash Player 6 or later, playing in Flash Player 7 or later.

Description

TextSnapshot objects let you work with static text in a movie clip. You can use them, for example, to lay out text with greater precision than that allowed by dynamic text, but still access the text in a read-only way.

You don't use a constructor to create a TextSnapshot object; it is returned by MovieClip.getTextSnapshot().

Method summary for the TextSnapshot object

Method	Description
TextSnapshot.findText()	Returns the position of the first occurrence of specified text.
TextSnapshot.getCount()	Returns the number of characters.
TextSnapshot.getSelected()	Specifies whether any of the text in the specified range has been selected by TextSnapshot.setSelected().
TextSnapshot.getSelectedText()	Returns a string that contains all the characters specified by TextSnapshot.setSelected().
TextSnapshot.getText()	Returns a string containing the characters in the specified range.
TextSnapshot.hitTestTextNearPos()	Lets you determine which character within the object is on or near specified coordinates.
TextSnapshot.setSelectColor()	Specifies the color to use when highlighting characters that have been selected with the TextSnapshot.setSelected() command.
TextSnapshot.setSelected()	Specifies a range of characters to be selected or deselected.

Method

Description

TextSnapshot.findText()

Returns the position of the first occurrence of specified text.

TextSnapshot.getCount()

Returns the number of characters.

TextSnapshot.getSelected()

Specifies whether any of the text in the specified range has been selected by TextSnapshot.setSelected().

TextSnapshot.getSelectedText()

Returns a string that contains all the characters specified by TextSnapshot.setSelected().

TextSnapshot.getText()

Returns a string containing the characters in the specified range.

TextSnapshot.hitTestTextNearPos()

Lets you determine which character within the object is on or near specified coordinates.

TextSnapshot.setSelectColor()

Specifies the color to use when highlighting characters that have been selected with the TextSnapshot.setSelected() command.

TextSnapshot.setSelected()

Specifies a range of characters to be selected or deselected.

Comments

K___H said on Apr 19, 2005 at 1:40 PM :

How about adding in a TextSnapshot.getHTMLText() function?

K___H said on Apr 19, 2005 at 1:42 PM :

Just a little clarification on the above comment:
Font, weight, color, etc. would be very useful -- maybe all of this info is not stored in any manner that is accessible with static text, but it certainly would be useful.

swartz1999 said on Apr 28, 2005 at 2:09 PM :

Thanks for wrting, K_H. LiveDocs comments are for documentation comments and they are reviewed by Technical Writers only. I encourage you to submit a feature request using our feature request page:
http://www.macromedia.com/support/email/wishform/