DynaPDF Manual - Page 365

Previous Page 364   Index   Next Page 366

Function Reference
Page 365 of 839
GetAnnotEx
Syntax:
LBOOL pdfGetAnnotEx(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Annotation handle
struct TPDFAnnotationEx ADDR Annot) // Structure to be filled
struct TPDFAnnotationEx
{
TAnnotType
Type;
LBOOL
Deleted;
// Marked as deleted?
struct TPDFRect BBox;
// Bounding box in bottom-up coordinates
float
BorderWidth;
UI32
BorderColor;
TBorderStyle
BorderStyle;
UI32
BackColor;
UI32
Handle;
char*
AuthorA;
UI16*
AuthorW;
char*
ContentA;
UI16*
ContentW;
char*
NameA;
UI16*
NameW;
char*
SubjectA;
UI16*
SubjectW;
UI32
PageNum;
THighlightMode
HighlightMode;
// Page link annotations only
SI32
DestPage;
struct TPDFRect DestPos;
TDestType
DestType;
char*
DestFile; // File link or web link annotations
// The Icon type depends on the annotation type. If the annotation type
// is atText the Icon is of type TAnnotIcon. If the annotation type is
// atFileAttach then it is of type TFileAttachIcon. If the annotation
// type is atStamp the Icon is the stamp type (TRubberStamp).
// For any other annotation type this value is not set (-1).
SI32
Icon;
char*
StampName;
// Set only, if Icon == rsUserDefined
UI32
AnnotFlags;
// See TAnnotFlags for available flags
char*
CreateDate;
// Optional Creation Date
char*
ModDate;
// Optional Modification Date
// Grouped is meaningful only if Parent != -1 and Type != atPopUp. If
// true, the annotation is part of an annotation group. Properties like
// Content, CreateDate, ModDate, BackColor, Subject, and Open must be
// taken from the parent annotation.
LBOOL
Grouped;
LBOOL
Open;
// If the annotation has a PopUp annotation.
// The Parent annotation handle is set if the annotation is a PopUp
// Annotation or if this annotation represents a state of a base
// annotation. In this case, the annotation type is always atText and
// only the following members should be considered:
//
State
-> The current state
//
StateModel -> Marked, Review, and so on
//
CreateDate -> Creation Date
//
ModDate
-> Modification Date
//
Author
-> The user who has set the state
//
Content
-> Not displayed in Adobe's Acrobat...
//
Subject
-> Not displayed in Adobe's Acrobat...
// The PopUp annotation of a text annotation which represent an
// Annotation State must be ignored.
SI32
Parent;
SI32
PopUp;
// Handle of the PopUp annotation if any
 

Previous topic: GetAnnotBBox, GetAnnotCount

Next topic: Optional Content, Migration states