AnnDistance property (ILEADRasterAnnotation)

Remarks

(Read only) This property is updated with the length of the ruler in the object passed to the AnnGetDistance method. The unit of measure for the ruler is set by calling the AnnSetUnit method.

Please note the following:

• If the annotation object passed to the AnnGetDistance method is type ANN_OBJECT_RULER, then the AnnGetDistance method returns the length of the ruler and this property is not updated.

• If the annotation object passed to the AnnGetDistance method is type ANN_OBJECT_CROSSPRODUCT, ANN_OBJECT_PROTRACTOR or ANN_OBJECT_POLYRULER, then the method returns the length of the primary ruler and this property is updated with the length of the second ruler. (The AnnGetDistance 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.)

• For annotations of 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