DynaPDF Manual - Page 228

Previous Page 227   Index   Next Page 229

Function Reference

Page 228 of 874

The function draws a circle annotation on the current open page. If the parameters Width and Height

are equal the function draws a circle, an ellipse otherwise. If the annotation should be drawn

without a border, set the parameter LineWidth to zero or StrokeColor to the special constant

NO_COLOR.

If the interior should be transparent set FillColor to the special constant NO_COLOR.

Although the line width can be set to any positive floating point value, Adobe’s Acrobat or Reader

restrict the line width to 0 through 12 units. The line width should be restricted in the same way to

avoid issues in Adobe viewer products.

Remarks:

This function is implemented in an Ansi and Unicode compatible variant. Ansi strings are

interpreted in the Windows code page 1252.

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.

ClearAutoTemplates

Syntax:

SI32 pdfClearAutoTemplates(

const PPDF* IPDF) // Instance pointer

This function deletes the array of templates which are automatically added to newly created pages.

See AutoTemplate() for further information.

Return values:

If the function succeeds the return value is 1. If the function fails the return value is 0.

ClearErrorLog

Syntax:

void pdfClearErrorLog(

const PPDF* IPDF) // Instance pointer

The clears the error log. The error log can be cleared before another function will be executed. This

makes it easier to determine whether errors occurred during execution of a specific function.

The error log is always cleared when the PDF file in memory is released.

ClearHostFonts

Syntax:

SI32 pdfClearHostFonts(

const PPDF* IPDF) // Instance pointer

Previous topic: CheckFieldNames, CircleAnnot

Next topic: ClipPath