PushPin Annotation Object

Note:

This topic is for Document/Medical only.

The PushPin annotation object (ANN_OBJECT_PUSHPIN) is a rectangle containing a scaled image that can be activated to show a hidden note. With the automated functions, in design mode, the user clicks and drags to specify the rectangle in the current window. A dialog box then lets the user specify the preferred options. In run mode, clicking on the icon display the hidden note.

A pushpin object has a primary bitmap, (manipulated using the AnnSetBitmap method/AnnGetBitmap method ) when the text is shown, and a secondary bitmap, changed using AnnSetSecondaryBitmap method . The primary bitmap is shown with the note text. The secondary bitmap is shown by itself when the note is minimized.

In design mode, the PushPin object shows the text and displays the primary bitmap. In run mode, the object shows/hides the text when clicked. The pushpin object has the active mode property. When the mode is ANNACTIVE_ENABLED, the text is shown and the primary bitmap is painted in the top-left corner of the note.

When the mode is ANNACTIVE_DISABLED, the text is hidden and the secondary bitmap is displayed.

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

With low-level functions, you must define the size and position of the rectangle. 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.

Foreground color

Defaults to red. It can be changed using the AnnSetForeColor method.

Background color

Defaults to yellow. 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.

Bitmap

Defaults to NULL. It can be changed using the AnnSetBitmap method.

SecondaryBitmap

Defaults to a Push pin bitmap. It can be changed using the AnnSetSecondaryBitmap 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.

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:

Implementing Annotations

Types of Annotations

Low-Level Coordinate System for Annotations

Using Annotation Bitmap Objects