AnnGetUnit method (ILEADRasterAnnotation)

Visual Basic example

Visual C++ 5.0 example

 

Syntax

BSTR AnnGetUnit(long hObject);

Overview

Refer to Implementing Annotations.

Remarks

(Document/Medical only) Fills the AnnUnit property with the current unit of measurement values set by AnnSetUnit method.

Read the AnnUnit property and AnnPrecision property after calling this mthod to get the current Unit and Precision.

The following annotation objects utilize one or more rulers as part of the annotation:

ANN_OBJECT_RULER

ANN_OBJECT_POLYRULER

ANN_OBJECT_PROTRACTOR

ANN_OBJECT_CROSSPRODUCT

In addition, the Automation object stores ruler settings along with the other object default settings.

The default unit of measure for ruler, polyruler, and crossproduct objects is Smart English. With the smart units, the unit changes with the length. For example, if the length is 11 inches (assuming the default precision of 2 is being used), "11.00 in" displays whereas if the length is 15 inches, "1 ft 3.00 in" displays. Call the AnnSetUnit method to set the unit of measurement and its precision for the ruler. The precision indicates how many digits to display to the right of the decimal point in the length. Call the AnnGetUnit method to fill the AnnUnit Property with the unit of measurement and its precision for the ruler. The AnnGetDistance2 method gets the length of each ruler that makes up an object, and the total length of all rulers.

See Also

Elements

AnnAlpha property, AnnAutoSnapCursor property, AnnCalibrateRuler method, AnnFillMode property, AnnGetFillModeExt method, AnnGetOptions method, AnnGetRotateOptions method, AnnGetTextOptions method, AnnSetFillModeExt method, AnnSetOptions method, AnnSetRotateOptions method, AnnSetTextOptions method, AnnShowBorder property, AnnShowRotateHandles property, AnnShowText property, AnnTextColor property, AnnTextEdit method, AnnSetGaugeLength method, AnnSetBitmapDpiX method, AnnGetBitmapDpiX method, AnnGetBitmapDpiY method, AnnSetBitmapDpiY method, AnnSetUnit method, AnnGetDistance method, AnnGetGaugeLength method, AnnUnit property, AnnPrecision property

Topics

Annotations (Document/Medical only): Object Manipulation

 

Obtaining Annotation Object Information