Flash CS3 Documentation

ActionScript 2.0 Language Reference > ActionScript classes > Rectangle (flash.geom.Rectangle) > contains (Rectangle.contains method)

contains (Rectangle.contains method)

Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.

Availability: ActionScript 1.0; Flash Player 8

Parameters

x:Number - The x-value (horizontal position) of the point.

y:Number - The y-value (vertical position) of the point.

Returns

Boolean - If the specified point is contained in the Rectangle object, returns true; otherwise false.

Example

The following example creates a Rectangle object and tests whether each of three coordinate pairs falls within its boundaries.

import flash.geom.Rectangle;

var rect:Rectangle = new Rectangle(10, 10, 50, 50);
trace(rect.contains(59, 59)); // true
trace(rect.contains(10, 10)); // true
trace(rect.contains(60, 60)); // false

See also

Point (flash.geom.Point)

Flash CS3