PushPin Annotation Object

(Document and Medical Imaging toolkits)

The PushPin annotation object (ANNOBJECT_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 displays the hidden note.

A PushPin object has a primary bitmap, (manipulated using the L_AnnSetBitmap and the L_AnnGetBitmap functions) when the text is shown, and a secondary bitmap, changed using the L_AnnSetSecondaryBitmap function. 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 (manipulated using the L_AnnSetActiveState and the L_AnnGetActiveState functions). 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.

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

Selected

Defaults to FALSE. It can be changed using the L_AnnSetSelected function.

Name

Defaults to an empty string. It can be changed using the L_AnnSetNameOptions function.

Foreground color

Defaults to red. It can be changed using the L_AnnSetForeColor function.

Background color

Defaults to yellow. It can be changed using the L_AnnSetBackColor function. 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 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.

Text

Defaults to "AaBbYyZz". It can be changed using the L_AnnSetText function.

Text Displayed

Defaults to Show text. It can be changed using L_AnnSetTextOptions.

Text Color

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

Bitmap

Defaults to NULL. It can be changed using the L_AnnSetBitmap function.

SecondaryBitmap

Defaults to a PushPin bitmap. It can be changed using the L_AnnSetSecondaryBitmap 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.

Tag (identifier)

Defaults to 0. It can be changed using the L_AnnSetTag function.

Window handle

Defaults to NULL or the handle inherited from the container. It can be changed for all objects using the L_AnnSetWnd function.

User mode

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

* Note: These features must be enabled using the L_AnnSetOptions function.

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

Related topics:

Implementing Annotations.

Types of Annotations.

Low-Level Coordinate System for Annotations.

Annotation Objects - Automated Features

Using Annotation Bitmap Objects

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help