TextSnapshot.hitTestTextNearPos()

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.hitTestTextNearPos(x, y [, maxDistance] )

Parameters

x A number that represents the x coordinate of the movie clip containing the text in my_snap.

y A number that represents the x coordinate of the movie clip containing the text in my_snap.

maxDistance An optional number that represents the maximum distance from x, y that can be searched for text. The distance is measured from the centerpoint of each character. The default value is 0.

Returns

An integer representing the index value of the character in my_snap that is nearest to the specified x, y coordinates, or -1 if no character is found.

Description

Method; lets you determine which character within a TextSnapshot object is on or near specified x, y coordinates of the movie clip containing the text in my_snap.

If you omit or pass a value of 0 for maxDistance, the location specified by the x, y coordinates must lie inside the bounding box of my_snap.

See also

MovieClip.getTextSnapshot(), MovieClip._x, MovieClip._y