In This Topic ▼

LImageViewerCell::SetRulerUnit

#include "ltwrappr.h"

L_INT LImageViewerCell::SetRulerUnit(uUnit, uFlags)

Changes the measurement unit used for the viewer ruler.

Parameters

Value that represents the measurement unit used for the viewer ruler. Possible values are:

Value	Meaning
CONTAINER_RULERUNIT_INCHES	[0] Inches.
CONTAINER_RULERUNIT_FEET	[1] Feet.
CONTAINER_RULERUNIT_MICROMETERS	[2] Micrometers.
CONTAINER_RULERUNIT_MILLIMETERS	[3] Millimeters.
CONTAINER_RULERUNIT_CENTIMETERS	[4] Centimeters.
CONTAINER_RULERUNIT_METERS	[5] Meters.

Reserved for future use. Pass 0.

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

To retrieve the current measurement unit used for the viewer ruler, call the LImageViewerCell::GetRulerUnit function.

The annotation ruler and the cell ruler measurement unit values change depending on the value passed to the uUnit parameter.

Required DLLs and Libraries

LTIVW
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Help Version 21.0.2021.7.2