within

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
within(<object>, <point>)
Summary

Returns true if a point is within an object, false if not.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, mobile
Parameters
NameTypeDescription
object

Any object reference.

point

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.)

Example
within(scrollbar ID 3,"33,40")
within(field "News Items",the clickLoc)
Values
NameTypeDescription
return

The within function returns true or false.

RelatedProperty: filled, menuMode, pixels, selected
Operator: is not within, is within
Keyword: button, image, rectangle, point, graphic
Object: button, image, stack, graphic
Function: intersect, mouseControl
Glossary: property, return, title bar, object
Control Structure: function
Description

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

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

<a href="point_LCS_glossary.html">point</a> is within the rect of <a href="object_LCS_glossary.html">object</a> 

is equivalent to

within(<a href="object_LCS_glossary.html">object</a>, <a href="point_LCS_glossary.html">point</a>)

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

Tagsui