AnnGetDistance2 method (Annotation Control)

C++ Builder example

Delphi example

 

Builder Syntax

int AnnGetDistance2(HANNOBJECT hObject)

Delphi Syntax

AnnGetDistance2 (hObject: HANNOBJECT): L_INT

Overview

Refer to Implementing Annotations.

Remarks

(Document/Medical only) Gets the length of each ruler that makes up an object, and the total length of all rulers.

This method works only for the following objects:

image\sqrblit.gif ANNOBJECT_RULER

image\sqrblit.gif ANNOBJECT_PROTRACTOR

image\sqrblit.gif ANNOBJECT_CROSSPRODUCT

image\sqrblit.gif ANNOBJECT_POLYRULER

The ANNOBJECT_POLYRULER object is composed of a variable number of rulers. The other ruler objects are composed of a predetermined number of rulers, as follows:

ANNOBJECT_RULER always has one distance.

ANNOBJECT_PROTRACTOR and ANNOBJECT_CROSSPRODUCT always have two distances.

ANNOBJECT_POLYRULER can have from one to any number of distances.

This method will update the properties listed below with information about the ruler(s) contained in the specified object:

AnnTotalDistance property

AnnTotalRulerUnit property

AnnTotalSmartUnit property

AnnDistance property

AnnRulerUnit property

AnnSmartUnit property

AnnDistanceCount property

See Also

Elements:

AnnTotalDistance property, AnnTotalRulerUnit property, AnnTotalSmartUnit property, AnnDistance property, AnnRulerUnit property, AnnSmartUnit property, AnnDistanceCount property

Topics:

Annotations: Object Manipulation

 

Using Rulers in Annotation Objects

 

New Annotation Features of Version 14.5