Ruler Annotation Object

(Document and Medical Imaging toolkits)

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.

For information on flipping, reversing or rotating annotation objects, refer to Flipping, Reversing and Rotating Annotation Objects.

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 L_AnnSetVisible function.
Selected	Defaults to FALSE. It can be changed using the L_AnnSetSelected function.
Name	Defaults to an empty string. It can be changed using the L_AnnSetNameOptions function.
Line width	Defaults to 0.75 points. It can be changed using the L_AnnSetLineWidth function. (Note that when displayed, the line must have a minimum width of 1 pixel.)
Line style	Defaults to solid. It can be changed using the L_AnnSetLineStyle function.
ROP2 code	Defaults to ANNROP2_COPY. It can be changed using the L_AnnSetROP2 function.
Fill mode	Defaults to transparent. It can be changed using the L_AnnSetFillMode function.
Foreground color	Defaults to red. It can be changed using the L_AnnSetForeColor function.
Background color	Defaults to white. It can be changed using the L_AnnSetBackColor function. The default does not affect highlight, redaction, or note objects.
Font size	Defaults to 10 point, translated with a scaling factor of 1. It can be changed using the L_AnnSetFontSize function.
Font underline	Defaults to FALSE. It can be changed using the L_AnnSetFontUnderline function.
Font strikethrough	Defaults to FALSE. It can be changed using the L_AnnSetFontStrikeThrough function.
Font italic	Defaults to FALSE. It can be changed using the L_AnnSetFontItalic function.
Font bold	Defaults to FALSE. It can be changed using the L_AnnSetFontBold function.
Font name	Defaults to "Arial". It can be changed using the L_AnnSetFontName function.
Ruler show flags	Defaults to ANNSHOW_LENGTH + ANNSHOW_TICMARKS., using smart English as the measurement unit with a precision of 2, and a tic mark length of 30. These options can be changed using the L_AnnSetShowFlags function, the L_AnnSetGaugeLength function, and the L_AnnSetUnit function.
Gauge length	Defaults to 30. It can be changed using the L_AnnSetGaugeLength function.
Unit	Defaults to ANNUNIT_SMART_ENGLISH. It can be changed using the L_AnnSetUnit function.
Unit abbreviation	Varies depending on the length shown. It can be changed using the L_AnnSetUnit function.
Precision	Defaults to 2. It can be changed using the L_AnnSetUnit function.
Fixed State	Defaults to not fixed. It can be changed using the L_AnnSetFixed function.
Hyperlink	Defaults to None. It can be changed using the L_AnnSetHyperlink function.
Tag (identifier)	Defaults to 0. It can be changed using the L_AnnSetTag function.
Window handle	Defaults to NULL or the handle inherited from the container. It can be changed for all objects using the L_AnnSetWnd function.
User mode	Defaults to design mode or the mode inherited from the container. It can be changed for all objects using the L_AnnSetUserMode function.