DynaPDF Manual - Page 516

Previous Page 515   Index   Next Page 517

Function Reference
Page 516 of 839
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.
Return values:
If the function succeeds the return value is the annotation handle, a value greater or equal zero. If
the function fails the return value is a negative error code.
ImportBookmarks
Syntax:
SI32 pdfImportBookmarks(
const PPDF* IPDF) // Instance pointer
This function imports the outline tree of the currently opened import file (see OpenImportFile() or
OpenImportBuffer()).
Return values:
If the function succeeds the return value is the number of imported bookmarks. If the function fails
the return value is a negative error code.
 

Previous topic: HaveDPartRoot, HaveOpenDoc, HaveOpenPage

Next topic: ImportCatalogObjects, ImportDocInfo