AnnoObjGetProperty

#include “BiAnno.h”

BOOL CALLBACK AnnoObjGetProperty(INT_PTR pAnno, Anno_Prop *pProp)

Description

Loads the properties of the selected annotation into an Anno_Prop structure provided by the user.

Parameters

            Anno_Prop structure:

lObjType           The type of the object. May take one of the following values:

A_WOUT

A_NOTE

A_STAMP

A_HIGHLIGHT

A_LINE

A_RECT

A_CIRCLE

A_ROUNDEDRECT

A_TEXT

A_FREEHAND

A_META

A_RUBBERSTAMP

A_VOICE

A_COMMENT

A_TEXTBOX

A_MULTILINETEXTBOX

A_CHECKBOX

lPosX               X coordinate of the upper-left corner of the object. In case of an A_LINE type object, this field is the X coordinate of the starting point

lPosY               Y coordinate of the upper-left corner of the object. In case of an A_LINE type object, this field is the Y coordinate of the starting point

lWidth               Width of the object. In case of an A_LINE type object, this field is the X coordinate of the end point.

lHeight              Height of the object. In case of an A_LINE type object, this field is the Y coordinate of the end point.

lColor               Color of the object. May take one of the following values:

A_BLACK

A_GRAY

A_BLUE

A_RED

A_PURPLE

A_GREEN

A_LBLUE

A_YELLOW

A_LGRAY

A_WHITE

lLine_Width       The width of the object outline. May be any positive integer.

lLine_Type        Type of the object outline. May take one of the following values:

A_SIMPLE

A_ARROW

A_FILLED_ARROW

A_DB_ARROW

A_DB_FILLED_ARROW

lOnPage           The object is on this page.

pszText             Pointer to the text of the yellow sticker (A_NOTE) objects.

For A_COMMENT annotations, please use AnnoObjGetCommentText.

For A_NOTE annotations saved with version 12.54 or newer, please use AnnoObjGetNoteText.

sLogFont          Font used by A_NOTE, A_TEXT, A_TEXTBOX, A_MULTILINETEXTBOX  and A_COMMENT objects. The type is LOGFONTA.

lpFileName        Name of the meta or timestamp file in A_META objects. To access the metafile or timestamp in memory, please use AnnoObjGetTimeStampMetafile

hBitmap            A valid bitmap handle for an A_STAMP type object.

lStampMode     The transparency mode of an A_STAMP type object.

lOnLayer           The object is on this layer.

bRubberStampType      Rubber stamp type of the A_RUBBERSTAMP object.

bRed                If lColor is undefined (-1), this specifies the red component of RGB color of the annotation object.

bGreen             If lColor is undefined (-1), this specifies the green component of RGB color of the annotation object.

bBlue                If lColor is undefined (-1), this specifies the blue component of RGB color of the annotation object.

LNoteTextColor Color of the text of the A_NOTE or A_COMMENT object.

lHAlign              Horizontal text alignment on the A_TEXT, A_TEXTBOX, A_MULTILINETEXTBOX  or A_NOTE object.

lVAlign              Vertical text alignment on the A_TEXT, A_TEXTBOX, A_MULTILINETEXTBOX  or A_NOTE object.

bBorder            Specifies the border of the annotation object.

bOpaque          Specifies the transparency of the annotation object.

byHyperlinkType           Type of hyperlink in the annotation object.

pszHyperlink     Pointer to hyperlink string in the annotation object.

pszVoiceFile     Path and name of the wav file for A_VOICE object.

lBKColor           Background color of the A_RECT, A_CIRCLE or A_ROUNDEDRECT rectangle object.

Return value

TRUE if the properties of the selected object were successfully loaded into the structure. FALSE if no annotation object was selected.

Programming Notes

The properties listed here can also be retrieved by individual getter functions.

For more information on specific annotations, please see Object creation process.

Code Example

None