AnnGetDistance2 method (ILEADRasterAnnotation)

Visual Basic example

Visual C++ 5.0 example

 

Syntax

short AnnGetDistance2 (long hObject);

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 ANN_OBJECT_RULER

image\sqrblit.gif ANN_OBJECT_PROTRACTOR

image\sqrblit.gif ANN_OBJECT_CROSSPRODUCT

image\sqrblit.gif ANN_OBJECT_POLYRULER

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

ANN_OBJECT_RULER always has one distance.

ANN_OBJECT_PROTRACTOR and ANN_OBJECT_CROSSPRODUCT always have two distances.

ANN_OBJECT_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:

TotalDistance property

TotalRulerUnit property

TotalSmartUnit property

Distance property

RulerUnit property

SmartUnit property

DistanceCount property

See Also

Elements:

AnnGetFillModeExt method, AnnSetFillModeExt method, AnnFillMode property, AnnAlpha property, AnnSetOptions method, AnnGetOptions method, AnnSetTextOptions method, AnnGetTextOptions method, AnnShowText property, AnnShowBorder property, AnnTextColor property, AnnAutoSnapCursor property, AnnTextEdit method, AnnShowRotateHandles property, AnnGetRotateOptions method, AnnSetRotateOptions method, AnnCalibrateRuler method, TotalDistance property, TotalRulerUnit property, TotalSmartUnit property, Distance property, RulerUnit property, SmartUnit property, DistanceCount property

Topics:

Annotations (Document/Medical only): Object Manipulation

 

Using Rulers in Annotation Objects

 

Obtaining Annotation Object Information

 

New Annotation Features of Version 14.5

 

Calibrating Annotation Ruler Objects