SubPath.IsOnSubPath

Function IsOnSubPath(x As Double, y As Double, [HotArea As Double = -1]) As cdrPositionOfPointOverShape

The IsOnSubPath method returns the position of a point relative to a subpath. The coordinate can be inside or outside the subpath, or over the outline of the subpath.

The IsOnSubPath method returns a value of cdrPositionOfPointOverShape.


Parameters	Description
x	Specifies the horizontal position, measured in document units, of a point
y	Specifies the vertical position, measured in document units, of a point
HotArea	Defines a restricted area on the curve’s subpath in which to evaluate the position of a point This parameter is optional, and its default value is -1.

The following code example creates a rectangle and tests where various point coordinates are located relative to the rectangle:

Public Sub Test() 
 Dim s As Shape, spath As SubPath 
 Set s = ActiveLayer.CreateRectangle(0, 0, 2, 2) 
 s.ConvertToCurves 
 Set spath = s.Curve.Subpaths(1) 
 ShowOnCurve 1, 1, spath.IsOnSubPath(1, 1) 
 ShowOnCurve 1, 0, spath.IsOnSubPath(1, 0) 
 ShowOnCurve 1, 3, spath.IsOnSubPath(1, 3) 
End Sub 
Private Function ShowOnCurve(x As Double, y As Double, v As 
cdrPositionOfPointOverShape) 
 Dim s As String 
 s = "Point (" & x & "," & y & ") is " 
 Select Case v 
  Case cdrOutsideShape 
   s = s & "outside the subpath" 
  Case cdrOnMarginOfShape 
   s = s & "over the outline" 
  Case cdrInsideShape 
   s = s & "inside the subpath" 
 End Select 
 MsgBox s 
End Function