IN_V1_ANNOTATION_* structures

image\bltlrgsq_shg.gif Editions  image\bltlrgsq_shg.gif Example

You can define, place, and retrieve descriptions of annotations by using the IN_PlaceVectorObject and IN_GetVectorObjectDescription functions, and the following structures:

image\bltlrgsq_shg.gif IN_OBJECT_HEADER

image\bltlrgsq_shg.gif IN_V1_ANNOTATION_PARMS

image\bltlrgsq_shg.gif IN_V1_ANNOTATION_OBJECT

IN_OBJECT_HEADER

Syntax

typedef struct tagApiObjectHeader {

IN_OBJECT_TYPE objectType;

USHORT  version;

USHORT  size;

USHORT  flags;

ULONG  objectID;

ULONG  parentID;

} IN_OBJECT_HEADER, FAR *IN_OBJECT_HEADER_PTR;

Parameters

Values

Meaning

objectType

IN_OBJTYPE_ANNOTATION (11)

 

version

1

version number

size

sizeof(IN_V1_ANNOTATION_OBJECT) + strlen(Annotationobject.string)

size of the data structure, including the string parameter in the annotation object structure

flags

IN_OBJFLAG_* values

 

objectID

identifier of the annotation

parentID

identifier of the group of objects that the annotation belongs to. Use 0 if the object is not part of a group.

IN_V1_ANNOTATION_PARMS

Syntax

typedef struct tagApiAnnotationParmsV1 {

IN_RGB color;

IN_TYPEFACE typeface;

char  fontName[82];

IN_MEASUREMENT height;

IN_MEASUREMENT width;

IN_ANGLE rotation;

IN_JUSTIFICATION justification;

IN_MIRROR mirror;

IN_BOOL iconized;

IN_BOOL centered;

IN_ANGLE orientation;

IN_ANGLE shear;

USHORT iconNumber;

IN_ICON_SIZE iconSize;

} IN_V1_ANNOTATION_PARMS, FAR *IN_V1_ANNOTATION_PARMS_PTR;

Parameters

Values

Meaning

color

RGB color

text color

typeface

IN_TYPEFACE_* values

typeface style to apply

 

-1

default typeface style

fontName

string, 82 characters or less

Windows-defined font name

height

Measurement structure

height of the text

width

Measurement structure

width of the text

rotation

floating point, in degrees

counter-clockwise rotation of the entire text string. Example

justification

IN_JUST_* values

position of annotation text

mirror

IN_MIRROR_* values

text mirroring

iconized

FALSE | TRUE

not iconized | iconized

centered

FALSE | TRUE

not centered | centered

orientation

floating point, in degrees

counter-clockwise rotation of each character in the text string. Example

shear

floating point, in degrees

slant of the text string. Example

iconNumber

0

placeholder

iconSize

1

placeholder

IN_V1_ANNOTATION_OBJECT

Syntax

typedef struct tagApiAnnotationObjectV1 {

IN_OBJECT_HEADER header;

IN_V1_ANNOTATION_PARMS parms;

IN_POINT point;

IN_ANNOTATION_TYPE type;

char  str[1];

} IN_V1_ANNOTATION_OBJECT, FAR *IN_V1_ANNOTATION_OBJECT_PTR;

Parameters

Values

Meaning

header

IN_OBJECT_HEADER

object header structure

parms

IN_V1_ANNOTATION_PARMS

annotation parameters

point

floating point, x1, y1

coordinates, in inches, for the annotation

type

IN_ANNOTYPE_ANNOTATION (1)

 

str[1]

string

text to place in the annotation. See Remarks.

Remarks

The str[] array is dynamically allocated based on the number of characters in the text.