Annotation Automation Object
Note: |
This topic is for Document/Medical only. |
The annotation automation object (ANN_OBJECT_AUTOMATION) is an object that lets you maintain default properties when using the automated annotation functions. This object has no position or dimensions. It is never placed in a container, but is associated with a root container accessed through the AnnContainer property.
Any properties that you set in the automation object become the default values for any new objects that are inserted into the associated container. In addition to the properties of other object types, the automation object also has properties, such as the default toolbar selection, that control the automated user interface.
This object has an automation tool property that you can use without implementing the toolbar. For example, if you want to supply your own toolbar or menu options, you can use the automation object alone to keep track of the tool selection.
Applicable properties have the following defaults, which you can change:
Automation tool |
Defaults to the selection pointer. It can be changed using the AnnTool property. |
Name |
Defaults to an empty string. It can be changed using the AnnSetNameOptions method. |
Line width |
Defaults to 0.75 points. It can be changed using the AnnSetLineWidth method. (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 AnnSetLineStyle method. |
ROP2 code |
Defaults to ANNROP2_COPY. It can be changed using the AnnSetROP2 method. |
Transparent option |
Defaults To Do Not Use Transparent Color. It can be changed using the AnnSetTransparent method. |
Transparent Color |
Defaults to White. It can be changed using the AnnSetTransparentColor method. |
Fill pattern |
Defaults to solid. It can be changed using the AnnSetFillPattern method. |
Fill mode |
Defaults to transparent. It can be changed using the AnnSetFillModeExt method. For version 14.5, before calling this method enable the alpha background fill mode by calling the AnnSetOptions method. |
Polygon fill mode |
Defaults to winding. It can be changed using the AnnSetPolyFillMode method. |
Foreground color |
Defaults to red. It can be changed using the AnnSetForeColor method. |
Background color |
Defaults to white. It can be changed using the AnnSetBackColor method. The default does not affect Highlight, Redaction, or Note objects. |
Note Background Color |
Defaults to yellow. It can be changed using the AnnSetAutoBackColor method. |
Redact Background Color |
Defaults to black. It can be changed using the LAnnSetAutoBackColor method. |
Hilite Background Color |
Defaults to yellow. It can be changed using the AnnSetAutoBackColor 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. |
Button Font |
Defaults to a regular MS Sans Serif red font at 10 points. |
Hotspot Metafile |
Defaults to a campfire graphic. It can be changed using the AnnSetPredefinedMetafile method. |
Encrypt Metafile |
Defaults to an image of a black skeleton key. It can be changed using the AnnSetPredefinedMetafile method. |
Decrypt Metafile |
Defaults to an image of a red skeleton key. It can be changed using the AnnSetPredefinedMetafile method. |
Ruler |
Defaults to Show Length and Show Tic Marks, 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 AnnSetShowFlags method, the AnnSetGaugeLength method, and the AnnSetUnit method. |
Nodes |
Defaults to displaying every node. It can be changed using the AnnSetNodes method. |
Protractor |
Defaults to drawing the inside angle in degrees with a precision of 2 and at an arc radius of 30. These options can be changed using the AnnSetProtractorOptions method and the AnnSetShowFlags method. |
Point |
Defaults to using a bitmap and not using transparent color. These options can be changed using the AnnSetTransparent method, the AnnSetTransparentColor method, the AnnPredefinedRaster property, and the AnnSetBitmap method. |
Encrypt |
Defaults to Encryptor. Set encryption options using the AnnSetEncryptOptions method. |
Fixed State |
Defaults to not fixed. It can be changed using the AnnFixed property. |
Hyperlink |
Defaults to None. It can be changed using the AnnSetHyperlinkString method. |
Menus enabled |
Defaults to TRUE. It can be changed using the AnnAutoMenuEnable property. |
Automation text strings |
Default to hard-coded strings for menus and dialog boxes. Strings can be changed using the AnnSetAutoText method. |
Highlight Pen Color |
Defaults to white. It can be changed using the AnnAutoHilightPen property. |
Use the AnnSetOptions method and the AnnGetOptions method to control the following features:
Rubber Stamp Display Style
XP Style Annotation Toolbar
Alpha Background Fill Option
Annotation Rotate Option
Annotation Side Handles
Annotation Multi-select
Annotation Cursors
ESC to Cancel
Calibrate Ruler Feature
Dot Dash Lines
Text Annotation Options
For more information about these features, refer to New Annotation Features of Version 14.5.
If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the AnnGetTextOptions method and the AnnSetTextOptions method to set the objects to show or hide the text and to set the color of the text. In addition, if the annotation objects are text or stamp objects these methods can set the objects to show or hide the borders of the object. In version 14.5, note that these features must be enabled using the AnnSetOptions method.
Use the AnnSetFillMode method and the AnnGetFillMode method to manage the fill mode used by annotation objects. The AnnSetFillModeExt method and the AnnGetFillModeExt method extends the original methods to support the ANN_FILLMODE_ALPHA fill mode. Before calling these two methods, enable the alpha background fill mode by calling the AnnSetOptions method.
Related topics:
New Annotation Features of Version 14.5
Low-Level Coordinate System for Annotations.
Annotation Objects - Automated Features