Annotation Automation Object - Raster Imaging C API Help

Annotation Automation Object

(Document and Medical Imaging toolkits)

The annotation automation object (ANNOBJECT_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 using the L_AnnSetAutoContainer function.

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 L_AnnSetTool 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.

Transparent option

Defaults To Do Not Use Transparent Color. It can be changed using the L_AnnSetTransparent function.

Transparent Color

Defaults to White. It can be changed using the L_AnnSetTransparentColor function.

Fill pattern

Defaults to solid. It can be changed using the L_AnnSetFillPattern function.

Fill mode

Defaults to transparent. It can be changed using the L_AnnSetFillMode function. Before calling this function enable the alpha background fill mode by calling the L_AnnSetOptions function.

Polygon fill mode

Defaults to winding. It can be changed using the L_AnnSetPolyFillMode 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.

Note Background Color

Defaults to yellow. It can be changed using the L_AnnSetAutoBackColor function.

Redact Background Color

Defaults to black. It can be changed using the L_AnnSetAutoBackColor function.

Hilite Background Color

Defaults to yellow. It can be changed using the L_AnnSetAutoBackColor function.

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.

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 L_AnnSetPredefinedMetafile function.

Encrypt Metafile

Defaults to an image of a black skeleton key. It can be changed using the L_AnnSetPredefinedMetafile function.

Decrypt Metafile

Defaults to an image of a red skeleton key. It can be changed using the L_AnnSetPredefinedMetafile function.

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 L_AnnSetShowFlags function, the L_AnnSetGaugeLength function, and the L_AnnSetUnit function.

Nodes

Defaults to displaying every node. It can be changed using the L_AnnSetNodes function.

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 L_AnnSetProtractorOptions and the L_AnnSetShowFlags function.

Point

Defaults to using a bitmap and not using transparent color. These options can be changed using the L_AnnSetTransparent function, L_AnnSetTransparentColor function, the L_AnnSetPredefinedBitmap function, and the L_AnnSetBitmap function.

Encrypt

Defaults to Encryptor. Set encryption options using the L_AnnSetEncryptOptions 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.

Menus enabled

Defaults to TRUE. It can be changed using the L_AnnSetAutoMenuEnable function.

Automation text strings

Default to hard-coded strings for menus and dialog boxes. Strings can be changed using the L_AnnSetAutoText function.

Highlight Pen Color

Defaults to white. It can be changed using the L_AnnSetAutoHilightPen function.

Additional automation properties can be set with the following functions. For details, see the corresponding documentation.

L_AnnSetTextExpandTokens

L_AnnSetActiveState

L_AnnSetAutoContainer

L_AnnSetAutoDrawEnable

L_AnnSetAutoMenuEnable

L_AnnSetAutoText

L_AnnSetBackColor

L_AnnSetBitmapDpiX

L_AnnSetBitmapDpiY

L_AnnSetDpiX

L_AnnSetDpiY

L_AnnSetFillPattern

L_AnnSetFontBold

L_AnnSetFontItalic

L_AnnSetFontName

L_AnnSetFontSize

L_AnnSetFontStrikeThrough

L_AnnSetFontUnderline

L_AnnSetForeColor

L_AnnSetGaugeLength

L_AnnSetTicMarkLength

L_AnnSetHyperlink

L_AnnSetHyperlinkMenuEnable

L_AnnSetLineStyle

L_AnnSetLineWidth

L_AnnSetLineFixedWidth

L_AnnSetOffsetX

L_AnnSetOffsetY

L_AnnSetPoints

L_AnnSetPolyFillMode

L_AnnSetROP2

L_AnnSetRect

L_AnnSetSelected

L_AnnSetScalarX

L_AnnSetScalarY

L_AnnSetTag

L_AnnSetText

L_AnnSetTextAlign

L_AnnSetTextFixedSize

L_AnnSetTextRotate

L_AnnSetTextPointerFixed

L_AnnSetTool

L_AnnSetToolBarButtonVisible

L_AnnSetToolBarChecked

L_AnnSetTransparent

L_AnnSetUndoDepth

L_AnnSetUnit

L_AnnSetUserMode

L_AnnSetVisible

L_AnnSetWnd

L_AnnSetNodes

L_AnnSetProtractorOptions

L_AnnSetNameOptions

L_AnnSetShowFlags

L_AnnSetMetafile

L_AnnSetPredefinedMetafile

L_AnnSetSecondaryBitmap

L_AnnSetAutoMenuItemEnable

L_AnnSetAutoMenuState

L_AnnSetUser

L_AnnSetAutoDefaults

L_AnnSetTransparentColor

L_AnnSetAutoOptions

L_AnnSetAutoDialogFontSize

L_AnnSetGrouping

L_AnnSetAutoBackColor

L_AnnSetAutoUndoEnable

L_AnnSetEncryptOptions

L_AnnSetPredefinedBitmap

L_AnnSetPointOptions

L_AnnSetRestrictToContainer

L_AnnSetFixed

L_AnnSetAutoCursor

L_AnnSetUserData

L_AnnSetTextRTF

Use the L_AnnSetOptions function and the L_AnnGetOptions function to control the following features:

For more information about these features, refer to Annotation Features

If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the L_AnnGetTextOptions and the L_AnnSetTextOptions functions 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 functions can set the objects to show or hide the borders of the object. Note that these features must be enabled using the L_AnnSetOptions function.

The L_AnnSetFillMode and the L_AnnGetFillMode support the ANNMODE_ALPHA fill mode. Before calling these two functions, enable the alpha background fill mode by calling the L_AnnSetOptions function.

Related topics:

Implementing Annotations

Types of Annotations

Low-Level Coordinate System for Annotations.

Annotation Objects - Automated Features

Using Rulers in Annotation Objects

Using Annotation Bitmap Objects

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help