References ▼
#include "ltwrappr.h"
L_INT LImageViewerCell::GetRulerUnit(puUnit, uFlags)
Retrieves the measurement unit used for the viewer ruler.
Pointer to a variable to be updated with the measurement unit used for the viewer ruler, or any other measurement tool inside the image viewer. 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. This is the default value. |
| 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 change the viewer ruler unit, call the LImageViewerCell::SetRulerUnit function.
You can show the current measurement unit on the cell by passing the DISPWIN_TYPE_RULERUNIT to the parameter uType when calling the LImageViewerCell::SetCellTag function.
Required DLLs and Libraries
For an example, refer to LImageViewerCell::CalibrateRuler.