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

DynaPDF Manual - Page 566

Previous Page 565   Index   Next Page 567

Function Reference
Page 566 of 750
SI32 pdfRenameSpotColor(
const PPDF* IPDF,
// Instance pointer
const char* Colorant, // UTF-8 colorant name to change
const char* NewName)
// New name or NULL (see description)
The function renames the spot color Colorant to NewName in all Separation, DeviceN, and NChannel
color spaces in which the colorant can be found. If the parameter NewName is set to NULL, the
function renames the colorant to the special value None which produces no visible output.
The representation of the colorant in the alternate color space is left unchanged, also if the colorant is
set to the special value None or All. Note that the colorant names must be UTF-8 encoded Unicode
strings. If the strings are preceeded with a BOM (Byte Order Mark) then the BOM will be removed.
Return values:
The function returns the number of color spaces in which the colorant has been changed. If the
function fails the return value is a negative error code.
SI32 pdfRenderAnnotOrField(
const PPDF* IPDF,
// Instance pointer.
UI32 Handle,
// Annotation or field handle.
LBOOL IsAnnot,
// If false, Handle must be a field handle.
TButtonState State,
// The state that should be rendered.
struct TCTM* Matrix,
// PageSpace of TPDFRasterImage structure.
TRasterFlags Flags,
// As used with RenderPage().
TPDFPixFormat PixFmt,
// The pixel format.
TCompressionFilter Filter, // Only used if CreateImage() was called
// beforehand.
struct TPDFBitmap* Out)
// Required, see below.
struct TPDFBitmap
UI32 StructSize; // Must be set to sizeof(TPDFBitmap)
BYTE* Buffer;
// Raw image buffer
UI32 BufSize;
// Buffer size in bytes
SI32 DestX;
// x-coordinate in the main image (the rendered page)
SI32 DestY;
// y-coordinate in the main image (the rendered page)
UI32 Height;
// Image height in pixels
SI32 Stride;
// Scanline length in bytes
UI32 Width;
// Image width
The function renders an annotation or field independent of the page. The page must be rendered
with RenderPage() or RenderPageEx() beforehand since these functions calculate also the required

Previous topic: ReEncryptPDF

Next topic: Raw image output