AnnGetDistance method (ILEADRasterAnnotation)
Remarks
(Document/Medical only) Gets the distance of the ruler in the specified annotation object. The unit of measure is set by calling the AnnSetUnit method.
This method can be called for ANN_OBJECT_RULER, ANN_OBJECT_CROSSPRODUCT, ANN_OBJECT_PROTRACTOR and ANN_OBJECT_POLYRULER types of annotation objects. However, please note the following:
- If the annotation object is type ANN_OBJECT_RULER, then this method returns the length of the ruler.
- If the annotation object is type ANN_OBJECT_CROSSPRODUCT, ANN_OBJECT_PROTRACTOR or ANN_OBJECT_POLYRULER, then this method returns the length of the primary ruler and updates the AnnDistance property with the length of the second ruler. (This method does not provide a means for getting the lengths of all rulers of a polyruler object. To get that information, AnnGetDistance2 must be called.)
- If the annotation object is type ANN_OBJECT_CROSSPRODUCT, ANN_OBJECT_PROTRACTOR or ANN_OBJECT_POLYRULER, the AnnGetDistance2 method provides more information on the length of each ruler, the number of rulers, the unit of measure of each ruler and the total length of all rulers.
To determine the type of an annotation object, call the AnnGetType method.
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, AnnSetBitmapDpiX method, AnnGetBitmapDpiX method, AnnGetBitmapDpiY method, AnnSetBitmapDpiY method, AnnSetUnit method, AnnGetUnit method, AnnSetGaugeLength method, AnnGetGaugeLength method, AnnDistance property |
Topics: |
Annotations (Document/Medical only): Object Manipulation |
|
Using Rulers in Annotation Objects |
|
New Annotation Features of Version 14.5 |
|
Calibrating Annotation Ruler Objects |