Error getting tags :
error 404Error getting tags :
error 404 within | revDocs | RunRev
Welcome Guest (Log in)
Product Edition
Version
within
Basics
Expander triangle
Type
Function
Syntax
within(object,point)
Introduced
1.0
Environment
Desktop,Web
Platform Support
MacOS,Mac OS X,Windows,Linux
Security
None required
Summary
Returns true if a point is within an object, false if not.
Examples

within(scrollbar ID 3,"33,40")
within(field "News Items",the clickLoc)

Additional Comments
Expander triangle

Use the within function to determine whether a point is inside the specified object.

Parameters:

The object is any object reference.

The point is any expression that evaluates to a point--a vertical and horizontal distance from the top left of the current stack, separated by a comma. (If the object is a stack, the distance is from the top left of the screen.)

Value:

The within function returns true or false.

Comments:

If the point is within the clickable area of the object, the within function returns true, even if another object is layered on top of the object.

If the object is a graphic, its interior is considered to be within the graphic only if the graphic's filled property is true or the graphic is selected.

If the object is an image, only pixels that contain paint are considered to be within the image. Transparent parts of the image are not within the image, although they are within the image's rectangle.

If the object is a button whose menuMode is "tabbed", only the tabs are considered to be within the button. The area below the tabs is not within the button, although it is within the button's rectangle.

If the object is a stack, the within function returns true if the point is in the stack's content area, and false if the point is in the stack's title bar or borders.

The expression

point is within the rect of object

is equivalent to

within(object,point)

unless the object is a graphic or image, or a tabbed button.

User Comments
Expander triangle