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

DynaPDF Manual - Page 582

Previous Page 581   Index   Next Page 583

Function Reference
Page 582 of 750
The OnUpdateWindow() callback function is never excuted when rendering into a device context.
However, the members UpdateOnPathCount and UpdateOnImageCoverage should be initialized as
usual so that the window becomes updated from time to time. See RenderPage() for further
information.
Remarks:
At time of publication the function can be used on Windows only.
Return values:
When the page was fully rendered the return value is 1. When the page was not fully processed, e.g.
due to errors, the return value is 0.
RenderPageToImage (Rendering Engine)
Syntax:
LBOOL pdfRenderPageToImage(
const PPDF* IPDF,
// PDF Instance pointer
UI32 PageNum,
// Page number (numbering starts at 1)
const char* OutFile,
// Output file name or NULL
UI32 Resolution,
// Output resolution or 0
UI32 Width,
// Output width in pixels or 0
UI32 Height,
// Output height in pixels or 0
TRasterFlags Flags,
// See below
TPDFPixFormat PixFmt,
// Output pixel format
TCompressionFilter Filter,
// See below
TImageFormat Format)
// See below
// Flags which are not meaningful for this function are not listed
typedef enum
{
rfDefault
= 0x00000000,
rfScaleToMediaBox = 0x00000001,
rfIgnoreCropBox
= 0x00000002,
/*
The art, bleed, or trim box is first intersected with the media box
or crop box if present since these boxes represent the maximum extend
of the page. If the flag rfIgnoreCropBox is set, the boxes are
intersected with the media box. The page is scaled to the media or crop
box depending on the above flags. By default a page is scaled to the
crop box if present.
*/
rtClipToArtBox
= 0x00000004,
rtClipToBleedBox
= 0x00000008,
rtClipToTrimBox
= 0x00000010,
rtExclAnnotations = 0x00000020,
rtExclFormFields
= 0x00000040,
rfRotate90
= 0x00000100, // Rotate the page by 90 degress
rfRotate180
= 0x00000200, // Rotate the page by 180 degress
rfRotate270
= 0x00000400, // Rotate the page by 270 degress
rfExclPageContent = 0x00002000, // If set, only annotations and form fields will be rendered
rfExclButtons
= 0x00004000, // Exclude push buttons
rfExclCheckBoxes
= 0x00008000, // Exclude check boxes
rfExclComboBoxes
= 0x00010000, // Exclude combo boxes
rfExclListBoxes
= 0x00020000, // Exclude list boxes
rfExclTextFields
= 0x00040000, // Exclude text fields
rfExclSigFields
= 0x00080000, // Exclude signature fields
 

Previous topic: RenderPageEx (Rendering Engine)

Next topic: 1 Bit Rendering