Ruler Annotation Object
Note: This topic is for Document/Medical only.
The ruler annotation object (ANNOBJECT_RULER) is a simple line with gauges on both ends for measuring distance. With the automated functions, the ruler is started on a mouse-down event and completed on a mouse-up event.
With low-level functions, you must provide the points that define the ruler. Other applicable properties have the following defaults, which you can change:
Visible |
Defaults to FALSE. It can be changed using the AnnSetVisible method. |
Selected |
Defaults to FALSE. It can be changed using the AnnSetSelected method. |
Font size |
Defaults to 10 point, translated with a scaling factor of 1. It can be changed using the AnnSetFontSize method. |
Font underline |
Defaults to FALSE. It can be changed using the AnnSetFontUnderline method. |
Font strikethrough |
Defaults to FALSE. It can be changed using the AnnSetFontStrikethrough method. |
Font italic |
Defaults to FALSE. It can be changed using the AnnSetFontItalic method. |
Font bold |
Defaults to FALSE. It can be changed using the AnnSetFontBold method. |
Font name |
Defaults to "Arial". It can be changed using the AnnSetFontName method. |
Foreground color |
Defaults to black. It can be changed using the AnnSetForeColor method. |
Line width |
Defaults to 1. It can be changed using the AnnSetLineWidth method. (Values equate to a minimum of 1 pixel when displayed.) |
Line style |
Defaults to solid. It can be changed using the AnnSetLineStyle method. |
Gauge length |
Defaults to 30. It can be changed using the AnnSetGaugeLength method. |
Unit |
Defaults to ANNUNIT_MILIMETERS. It can be changed using AnnSetUnit method. |
Unit abbreviation |
Defaults to "mm". It can be changed using the AnnSetUnit method. |
Precision |
Defaults to 2. It can be changed using the AnnSetUnit method. |
Tag (identifier) |
Defaults to 0. It can be changed using the AnnSetTag method. |
Window handle |
Defaults to NULL or the handle inherited from the container. |
User mode |
Defaults to design mode or the mode inherited from the container. |
Related topics: