DynaPDF Manual - Page 379
Previous Page 378 Index Next Page 380
Function Reference
Page 379 of 860
GetAnnotColor
Syntax:
LBOOL pdfGetAnnotColor(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Annotation handle
TAnnotColor ColorType, // See below
TPDFColorSpace* CS,
// Out -> Color space in which Color is defined
UI32* Color)
// Out -> The color value
typedef enum
{
fcBackColor
= 0, // Link annotations support no background color!
fcBorderColor = 1,
fcTextColor
= 2
// Free Text annotation's only
}TFieldColor, TAnnotColor;
#define NO_COLOR 0xFFFFFFF1
The function retrieves the color of an annotation. If a color type is not supported by an annotation,
the function returns false and passes a warning to the error callback function if set. The parameters
CS and Color are both required and must not be NULL.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetAnnotCount
Syntax:
SI32 pdfGetAnnotCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of annotations currently used in the document. Note: This value
includes also annotations which were deleted by DeleteAnnotation() because annotations are not
physically deleted at runtime. This value can be used to loop over all annotations. Annotation
handles are simple array indexes.
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;
Previous topic: GetAnnotBBox
Next topic: Optional Content