DynaPDF Manual - Page 503

Previous Page 502   Index   Next Page 504

Function Reference

Page 503 of 821

HaveOpenDoc

Syntax:

LBOOL pdfHaveOpenDoc(

const PPDF* IPDF) // Instance pointer

If an error occurred it is not always clear whether the PDF file was already deleted or if it is still in

memory. Therefore, this function can be used to determine whether a PDF file is still in memory.

Return values:

If an open PDF file is in memory the return value is 1. If no open PDF file is in memory the return

value is 0.

HaveOpenPage

Syntax:

LBOOL pdfHaveOpenPage(

const PPDF* IPDF) // Instance pointer

The function returns true (1) if an open page is in memory. Otherwise the return value is false (0).

HighlightAnnot

Syntax:

SI32 pdfHighlightAnnot(

const PPDF* IPDF,

// Instance pointer

TAnnotType SubType,

// Allowed values are atHighlight, atSquiggly,

// atStrikeOut, or atUnderline

double PosX,

// X-Coordinate

double PosY,

// Y-Coordinate

double Width,

// Annotation height

double Height,

// Annotation width

UI32 Color,

// Highlight color

const char* Author,

// Optional author

const char* Subject, // Optional subject (PDF 1.5)

const char* Comment) // Optional comment

The function creates a Highlight annotation. Highlight annotations are used to mark text on a PDF

page.

If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the

bounding rectangle. If the coordinate system is top-down it defines the upper left corner.

The parameter Color specifies the highlight color; it must be defined in RGB color space. The line

width of a Strikout or Underline annotation is not adjustable. The line width depends on the size of

the annotation and is automatically calculated.

The active color space must be set to DeviceRGB before creating the annotation. See SetColorSpace()

for further information.

Previous topic: GetXFAStream, GetXFAStreamCount

Next topic: ImportBookmarks, ImportCatalogObjects, ImportDocInfo