GetRulerLengthAsStringFromPoints Method (original) (raw)

Summary

Gets the length of the ruler between two points as a string.

Syntax

C#

Objective-C

C++/CLI

Java

Python

public virtual string GetRulerLengthAsStringFromPoints( [LeadPointD](../l/leadpointd.html) _startPoint_, [LeadPointD](../l/leadpointd.html) _endPoint_, double _calibrationScale_ )

- (NSString *)rulerLengthAsStringFromPoint:(LeadPointD)startPoint to:(LeadPointD)endPoint scale:(double)calibrationScale; 

public String getRulerLengthAsStringFromPoints( LeadPointD _startPoint_, LeadPointD _endPoint_, double _calibrationScale_ )

public: virtual String^ GetRulerLengthAsStringFromPoints( [LeadPointD](../l/leadpointd.html)^ _startPoint_, [LeadPointD](../l/leadpointd.html)^ _endPoint_, double _calibrationScale_ )

def GetRulerLengthAsStringFromPoints(self,startPoint,endPoint,calibrationScale): 

Parameters

startPoint
The starting point of the ruler.

endPoint
The ending point of the ruler.

calibrationScale
The ratio of the horizontal resolution (dots per inch or DPI) to the vertical resolution. For most images, the ratio is 1.

Return Value

The length of the ruler as a string based on the calibrationScale.