Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 178

Previous Page 177   Index   Next Page 179

Function Reference
Page 178 of 750
CircleAnnot
Syntax:
SI32 pdfCircleAnnot(
const PPDF* IPDF,
// Instance pointer
double PosX,
// y-coordinate of the annotation
double PosY,
// x-coordinate of the annotation
double Width,
// Width of the annotation
double Height,
// Height of the annotation
double LineWidth,
// Line width of the circle or ellipse
UI32 FillColor,
// Fill color or NO_COLOR. See description
UI32 StrokeColor,
// Stroke color or NO_COLOR. See description
TPDFColorSpace CS,
// Color space of the fill and stroke colors
const char* Author,
// Optional author
const char* Subject, // Optional subject
const char* Comment) // Optional comment
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.
 

Previous topic: CheckFieldNames

Next topic: ClipPath