AnnSetUnit method (Annotation Control)

C++ Builder example

Delphi example

 

Builder Syntax

int AnnSetUnit (HANNOBJECT hObject, unsigned uUnit, AnsiString strUnitAbbrev, unsigned uPrecision, bool bSelected);

Delphi Syntax

Function AnnSetUnit (hObject: HANNOBJECT; uUnit: L_UINT; strUnitAbbrev: String; uPrecision: L_UINT; bSelected: Boolean ): L_INT;

Overview

Refer to Using Rulers in Annotation Objects

Remarks

(Document/Medical only) Sets the unit of measurement for a ruler.

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

ANNOBJECT_AUTOMATION

ANNOBJECT_RULER

ANNOBJECT_POLYRULER

ANNOBJECT_PROTRACTOR

ANNOBJECT_CROSSPRODUCT

To determine the unit of measure for each ruler, check the AnnRulerUnit property and the AnnSmartUnit property. 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. Use 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. Use the AnnGetUnit method to get the unit of measurement and its precision for the ruler. The AnnGetDistance2 method updates the following properties with information about the ruler(s) contained in the specified object:

AnnTotalDistance

AnnTotalRulerUnit

AnnTotalSmartUnit

AnnDistance

AnnRulerUnit

AnnSmartUnit

AnnDistanceCount

Refer to the AnnAutomation property.

See Also

Elements

AnnGetUnit method, AnnSetGaugeLength method, AnnGetDistance method, AnnGetGaugeLength method, AnnTicMarkLength property

Topics

Annotations (Document/Medical only): Object Manipulation

 

Using Rulers in Annotation Objects

 

New Annotation Features of Version 14.5