Monkeybread Software - DynaPDF Manual

DynaPDF Manual - Page 366

Previous Page 365 Index Next Page 367

Function Reference

Page 366 of 839

char*

State;

// The state of the annotation

char*

StateModel; // State model (Marked, Review, ...)

// FileAttach annotations only. This is a handle of an embedded file.

// The embedded file can be accessed with GetEmbeddedFile().

SI32

EmbeddedFile;

char*

Subtype;

// Set only, if Type == atUnknown

LBOOL

MarkupAnnot; // If true, the annotation is a markup

// annotation. Markup annotations can be

// flattened separately (FlattenAnnots()).

float

Opacity;

// Opacity = 1.0 = Opaque,

// Opacity < 1.0 = Transparent, Markup

// annotations only

float*

QuadPoints;

// Highlight, Link, and Redact annotations only

UI32

QuadPointsCount; // Number of values in the array. Since a quadpoint requires

// always four coordinate pairs, the number of QuadPoints is

// QuadPointsCount divided by 8.

float*

DashPattern;

// If BorderStyle == bsDashed

UI32

DashPatternCount;// Number of values in the array

char*

Intent;

// Markup annotations only. The intent allows to distinguish

// between different uses of an annotation. For example, line

// annotations have two intents: LineArrow and LineDimension.

TLineEndStyle LE1;

// Style of the start point -> Line and PolyLine annotations

only

TLineEndStyle LE2;

// Style of the end point -> Line and PolyLine annotations only

float*

Vertices;

// Line, PolyLine, and Polygon annotations only

UI32

VerticesCount;

// Number of values in the array. This is the raw number of

// floating point values. Since a vertice requires always two

// coordinate pairs, the number of vertices or points is

// VerticeCount divided by 2.

// Line annotations only. These properties should only be considered if the member Intent is set

// to the string "LineDimension".

LBOOL

Caption;

// If true, the annotation string Content is used as caption.

// The string is shown in a PopUp annotation otherwise.

float

CaptionOffsetX;

// Horizontal offset of the caption from its normal position

float

CaptionOffsetY;

// Vertical offset of the caption from its normal position

TLineCaptionPos CaptionPos;

// The position where the caption should be drawn if present

float

LeaderLineLen;

// Length of the leader lines (positive or negative)

float

LeaderLineExtend;// Optional leader line extend beyond the leader line

float

LeaderLineOffset;// Amount of space between the endpoints of the annotation and

// the leader lines.

TBorderEffect BorderEffect;

// Circle, Square, FreeText, and Polygon annotations.

char*

RichStyle;

// Optional default style string. -> FreeText annotations.

char*

RichText;

// Optional rich text string (RC key). -> Markup annotations.

const ILST**

InkList;

// Ink annotations only. Array of array. The sub arrays can be

// accessed with GetInkList().

UI32

InkListCount;

// Number of ink arrays.

SI32

OC;

// Handle of an OCG or OCMD or -1 if not set. See description.

};

The function returns the most important properties of an annotation. The parameter Handle must be

a valid annotation handle. All string values are pointers to the original string buffer. You must not

modify or free such a string. Reserved fields must be initialized with NULL.

The function returns also deleted annotations because DeleteAnnotation() does not physically delete

annotations.

Previous topic: GetAnnotEx

Next topic: Optional Content, Migration states