DynaPDF Manual - Page 587

Previous Page 586   Index   Next Page 588

Function Reference
Page 587 of 787
Remarks:
This function is implemented in an Ansi and Unicode compatible version.
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.
PolyLineAnnot
Syntax:
SI32 pdfPolyLineAnnot(
const PPDF* IPDF,
// Instance pointer
struct TFltPoint* Vertices, // At least two vertices must be provided
UI32 NumVertices,
// Number of vertices in the array
double LineWidth,
// Line width
TLineEndStyle Start,
// Line end style of the start point
TLineEndStyle End,
// Line end style of the end point
UI32 FillColor,
// Fill color or NO_COLOR = transparent
UI32 StrokeColor,
// Stroke color or NO_COLOR = transparent
TPDFColorSpace CS,
// Color space of the color values
const char* Author,
// Optional author
const char* Subject,
// Optional subject
const char* Content)
// Optional content or comment
typedef enum
{
leNone,
leButt,
leCircle,
leClosedArrow,
leDiamond,
leOpenArrow,
leRClosedArrow,
leROpenArrow,
leSlash,
leSquare
}TLineEndStyle;
The function creates a PolyLine Annotation. The vertices are connected by straight lines. At least
two vertices must be provided.
The coordinates of the vertices are interpreted in current user space. Any transformation that was
applied on the coordinate system will be taken into account.
The parameter FillColor is only used if the line end style of the start or end point has an interior that
can be filled. The special constant NO_COLOR represents a transparent interior.
The stroke color is required and must not be set to NO_COLOR.
This annotation type has an associated PopUp annotation that displays the string Content in a
floating window. The initial window state of the associated PopUp annotation is closed by default
but the state can be changed with SetAnnotOpenState() if necessary.
 

Previous topic: PlaceTemplByMatrix, PolygonAnnot

Next topic: PrintPage, PrintPDFFile

Start Chat