Monkeybread Software - MBS FileMaker Plugin: PDFKit.GetPDFPageImage

Topics All MacOS (Only) Windows (Only) Linux (Only, Not) iOS (Only, Not)
Components Crossplatform Mac & Win Server Client Old Deprecated Guides Examples Videos
New in version: 9.3 9.4 9.5 10.0 10.1 10.2 10.3 10.4 10.5 10.6 Statistic FMM Blog

PDFKit.GetPDFPageImage

Renders an image of a page in a PDF document.

Component	Version	macOS	Windows	Linux	Server	FileMaker iOS SDK
PDFKit	2.1	Yes	No	No	Yes, macOS only	Yes

MBS( "PDFKit.GetPDFPageImage"; PDF; index { ; ImageType; FileName; DPI; box; ClearBackground } ) More

Parameters

Parameter Description Example Flags

PDF A container value with the PDF content from a media field. Or a text with an URL. Or a PDF reference from PDFKit.Open.

index The index of the page.
From zero to PDFKit.GetPDFPageCount-1. 1

ImageType The type of image to return.
Either JPEG, PNG, GIF or BMP. Default is JPEG. "JPEG" Optional

FileName The filename to use for the picture.
Default is "image" with the extension matching the image type. "test.jpg" Optional

DPI The DPI to use for the resolution of the image. Default is 72. 72 Optional

box The PDF box to use. Can be Media Box = 0, Crop Box = 1, Bleed Box = 2, TrimBox = 3 or ArtBox = 4. If the box is not defined, we fall back to the media box. Default is 0. 1 Optional

ClearBackground Optionally, whether to have a transparent background (1) vs. a white background (0). Default is 0 for white. For JPEG, you can't pass 1. 0 Optional

Parameter	Description	Example	Flags
PDF	A container value with the PDF content from a media field. Or a text with an URL. Or a PDF reference from PDFKit.Open.
index	The index of the page. From zero to PDFKit.GetPDFPageCount-1.	1
ImageType	The type of image to return. Either JPEG, PNG, GIF or BMP. Default is JPEG.	"JPEG"	Optional
FileName	The filename to use for the picture. Default is "image" with the extension matching the image type.	"test.jpg"	Optional
DPI	The DPI to use for the resolution of the image. Default is 72.	72	Optional
box	The PDF box to use. Can be Media Box = 0, Crop Box = 1, Bleed Box = 2, TrimBox = 3 or ArtBox = 4. If the box is not defined, we fall back to the media box. Default is 0.	1	Optional
ClearBackground	Optionally, whether to have a transparent background (1) vs. a white background (0). Default is 0 for white. For JPEG, you can't pass 1.	0	Optional

Result

Returns a container with a JPEG picture of the PDF page. You can store it in a media field.

Description

Renders an image of a page in a PDF document.
With plugin version 2.4 you can specify format with ImageType parameter.

Due to bugs in Apple’s PDFKit you may see memory leaks with JPEG data from PDF pages (seen in macOS 10.12).
For Windows, Linux or iOS, please check DynaPDF.RenderPage or DynaPDF.GeneratePreview function.

Examples

Render page 2 of a PDF into a picture

MBS( "PDFKit.GetPDFPageImage"; $ref; 1; "jpeg"; "test.jpg"; 300; 1 )

Render first page of a PDF in a container:

MBS( "PDFKit.GetPDFPageImage"; TableName::ContainerFieldName; 0; "jpeg"; "image.jpg" )

Example Databases

Mac and iOS/PDFKit/Extract PDF Pages

Blog Entries

Release notes

Version 9.5
- Fixed problem with returning NSImages. Now passing pixel size to FileMaker, so images with DPI > 72 show correctly in container. e.g. for PDFKit.GetPDFPageImage function.

Created 18th August 2014, last changed 29th September 2020

PDFKit.GetPDFPageFormattedText - PDFKit.GetPDFPagePDF

Feedback: Report problem or ask question.