HitTest

<< Click to Display Table of Contents >>

Manual > Control Reference > Common to all controls > Common methods >

HitTest

 

Determines whether the object itself overlaps with the specified object or coordinate value.

 

syntax

HitTest(

         object

         )

 

Parameters

 

object

 

Type:

Object

 

The control that makes the decision.

 

Return Value

 

 

Type:

Boolean

 

FALSE - they do not overlap. TRUE - they do overlap.

 

hmtoggle_plus1Explanation

It is used to determine whether your object overlaps with other control objects.

Syntax 1 determines whether the outer perimeter (rectangle) of the control being compared overlaps with the outer perimeter (rectangle) of your own control.

 

 

hmtoggle_plus1Example


 

if (this.HitTest(parent.TargetControl))
{
//Processing when overlapping
}

 

 

Syntax 2

HitTest(

         x,

         y

         )

 

Parameters

 

x

 

Type:

Number

 

X coordinate

 

y

 

Type:

Number

 

Y coordinate

 

Return Value

 

 

Type:

Boolean

 

FALSE - they do not overlap. TRUE - they do overlap.

 

hmtoggle_plus1Explanation

It is used to determine whether your object overlaps with other control objects.

In Syntax 2, the method of determination differs for each control. For example, the Ellipse control determines whether the specified coordinates are inside the ellipse, not the outer boundary (rectangle).

 

 

hmtoggle_plus1Example


 

var x = 10;
var y = 20;
if (this.HitTest(x, y))
{
//Processing when overlapping
}

 

 

Supported

×

Script Action

Can be used in server script Ver2 actions

○

Browser script

Can be used in browser scripts

×

Calculation Expression Syntax

Can be used in expression syntax (e.g. bind syntax)

 

reference

 

GetParentObj

GetChildObj

GetChildObjCount

GetObjIndex

GetProperty

SetProperty

CopyProperty

GetSourceProperty

CallCommonEvent

CallMethod

HitTest

BringToFront

BringToBack

SetFocus

LostFocus

StartDrag

StartDragX

StartDragY

StopDrag

IsDrag

Intersect

GetMousePos