GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureImaging Class / GetDistance Method
A unique image identifier of the GdPicture image representing the image in use.
The horizontal (X) coordinate of the first point, in pixels.
The vertical (Y) coordinate of the first point, in pixels.
The horizontal (X) coordinate of the second point, in pixels.
The vertical (Y) coordinate of the second point, in pixels.





In This Topic
GetDistance Method (GdPictureImaging)
In This Topic
Returns the distance, in inches, between two specified points of the GdPicture image represented by its unique image identifier.
Syntax
'Declaration
 
Public Function GetDistance( _
   ByVal ImageID As Integer, _
   ByVal Left1 As Integer, _
   ByVal Top1 As Integer, _
   ByVal Left2 As Integer, _
   ByVal Top2 As Integer _
) As Double
public double GetDistance( 
   int ImageID,
   int Left1,
   int Top1,
   int Left2,
   int Top2
)
public function GetDistance( 
    ImageID: Integer;
    Left1: Integer;
    Top1: Integer;
    Left2: Integer;
    Top2: Integer
): Double; 
public function GetDistance( 
   ImageID : int,
   Left1 : int,
   Top1 : int,
   Left2 : int,
   Top2 : int
) : double;
public: double GetDistance( 
   int ImageID,
   int Left1,
   int Top1,
   int Left2,
   int Top2
) 
public:
double GetDistance( 
   int ImageID,
   int Left1,
   int Top1,
   int Left2,
   int Top2
) 

Parameters

ImageID
A unique image identifier of the GdPicture image representing the image in use.
Left1
The horizontal (X) coordinate of the first point, in pixels.
Top1
The vertical (Y) coordinate of the first point, in pixels.
Left2
The horizontal (X) coordinate of the second point, in pixels.
Top2
The vertical (Y) coordinate of the second point, in pixels.

Return Value

The resulting distance between two points, in inches. The GdPictureImaging.GetStat method can be subsequently used to determine if this method has been successful.
Remarks
It is recommend to use the GdPictureImaging.GetStat method to identify the specific reason for the method's failure, if any.

This method requires the Image Documents component to run.

See Also