Ruler Annotation Object

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.

The class for Ruler Annotation objects is LAnnRuler.

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:

Property	Default value
Visible	Defaults to FALSE. It can be changed using the LAnnotation::SetVisible function.
Selected	Defaults to FALSE. It can be changed using the LAnnotation::SetSelected function.
Name	Defaults to an empty string. It can be changed using the LAnnotation::SetNameOptions function.
Line width	Defaults to 0.75 points. It can be changed using the LAnnXXX::SetLineWidth 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 LAnnXXX::SetLineStyle function.
ROP2 code	Defaults to ANNROP2_COPY. It can be changed using the LAnnotation::SetROP2 function.
Fill mode	Defaults to transparent. It can be changed using the LAnnotation::SetFillMode function.
Foreground color	Defaults to red. It can be changed using the LAnnRuler::SetForeColor function.
Background color	Defaults to white. It can be changed using the LAnnotation::SetBackColor function.
Font size	Defaults to 10 point, translated with a scaling factor of 1. It can be changed using the LAnnXXX::SetFontSize function.
Font underline	Defaults to FALSE. It can be changed using the LAnnXXX::SetFontUnderline function.
Font strikethrough	Defaults to FALSE. It can be changed using the LAnnXXX::SetFontStrikethrough function.
Font italic	Defaults to FALSE. It can be changed using the LAnnXXX::SetFontItalic function.
Font bold	Defaults to FALSE. It can be changed using the LAnnXXX::SetFontBold function.
Font name	Defaults to "Arial". It can be changed using the LAnnXXX::SetFontName function.
Ruler	Defaults to Show Length and Show Tic Marks. These options can be changed using the LAnnRuler::SetShowFlags function and the LAnnRuler::SetTicMarkLength function.
Gauge length	Defaults to 30. It can be changed using the LAnnRuler::SetGaugeLength function.
Unit	Defaults to ANNUNIT_SMART_ENGLISH. It can be changed using the LAnnRuler::SetUnit function.
Unit abbreviation	Varies depending on the length shown. It can be changed using the LAnnRuler::SetUnit function.
Precision	Defaults to 2. It can be changed using the LAnnRuler::SetUnit function.
Fixed State	Defaults to not fixed. It can be changed using the LAnnXXX::SetFixed function.
Hyperlink	Defaults to ANNLINK_NONE. It can be changed using the LAnnotation::SetHyperlink function.
Tag (identifier)	Defaults to 0. It can be changed using the LAnnotation::SetTag function.
Window handle	Defaults to NULL or the handle inherited from the container. It can be changed for all objects using LAnnContainer::SetWnd.
User mode	Defaults to design mode or the mode inherited from the container. It can be changed for all objects using LAnnContainer::SetUserMode.

Ruler Annotation Object

See Also