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

DynaPDF Manual - Page 599

Previous Page 598   Index   Next Page 600

Function Reference
Page 599 of 750
LBOOL pdfSetAnnotBorderEffect(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Annotation handle
TBorderEffect Value) // See below
typedef enum
// Default
beCloudy1, // Circle diameter 9 units
// Circle diameter 17 units
The function sets or changes the border effect of a Square, FreeText, or Polygon annotation.
Circle annotations support the cloudy border effect too but this is not yet implemented.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
LBOOL pdfSetAnnotBorderStyle(
const PPDF* IPDF,
// Instance pointer
UI32 Handle,
// Annotation handle
TBorderStyle Style) // Border style
typedef enum
= 0, // Solid border
= 1, // Bevelled border
= 2, // Inset border
= 3, // Underline only
= 4, // Dashed border
bsUserDefined = 5
// Not allowed
The function sets or changes the border style of an annotation. Note that the border style has no
effect if the border width is set to zero or if the border color is set to NO_COLOR (see
SetAnnotColor(), SetAnnotBorderWidth()).
Note also that not all styles are meaningful for all annotation types. For example, while link
annotations support all border styles, FreeText annotations support the styles bsSolid and bsDashed
only. File Attach, Sound, Stamp, or Text annotations for example support no border style because
these annotation types contain no appearance on which a border style could be applied.
Setting the border style to an unsupported value causes no error; the value will be ignored instead.

Previous topic: SetAllocBy

Next topic: SetAnnotBorderWidth