Text Annotation Object

Note:

This topic is for Document/Medical only.

The text annotation object (ANN_OBJECT_TEXT) is a rectangle containing a character string with font properties. The text will wrap on word breaks within the object's specified rectangle. With the automated functions, the user clicks and drags to specify the rectangle in the current window. A dialog box then lets the user enter the text.

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

With low-level functions, you must specify the rectangle that contains the text. 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.

Name

Defaults to an empty string. It can be changed using the AnnSetNameOptions 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.

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.

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.

Text

Defaults to "AaBbYyZz". It can be changed using the AnnSetText method.

Text Displayed*

Defaults to Show text. It can be changed using AnnSetTextOptions method.

Text Color*

Defaults to red (RGB(255,0,0). It can be changed using AnnSetTextOptions.

Text Border*

Defaults to show the Border. It can be changed using AnnSetTextOptions.

Text Alignment

Defaults to left alignment. It can be changed using the AnnTextAlign property.

Expand Tokens

Defaults to expand tokens. It can be changed using the L AnnTextExpandTokens property.

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.

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. It can be changed for all objects using the AnnSetWnd method.

User mode

Defaults to design mode or the mode inherited from the container. It can be changed for all objects using the AnnUserMode property.

* Note that in version 14.5, these features must be enabled using the AnnSetOptions method.

Related topics:

image\sqrblit.gif Implementing Annotations.

image\sqrblit.gif Types of Annotations.

image\sqrblit.gif Low-Level Coordinate System for Annotations.

image\sqrblit.gif Annotation Objects - Automated Features