Topics   All functions   Mac OS X   Windows   Crossplatform   Server   Components   Guides   Statistic  
New in version: 3.0   3.1   3.2   3.3   3.4   3.5   4.0   4.1   4.2   4.3   4.4   5.0   5.1  


Component: PDFKit
Version: 2.1
Mac OS X: Yes
Windows: No
Server: Yes

MBS( "PDFKit.GetPDFPageImage"; PDF; Index; ImageType; Filename; DPI; box; ClearBackground )


Parameter Description Example value
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 Optional, the type of image to return. Either JPEG, PNG, GIF or BMP. Default is JPEG. "JPEG"
Filename Optional, the filename to use for the picture. Default is "image" with the extension matching the image type. "test.jpg"
DPI Optional, the DPI to use for the resolution of the image. Default is 72. 72
box Optional, 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
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


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


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


Render page 2 of a PDF into a picture

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

PDFKit.GetPDFPageFormattedText   -   PDFKit.GetPDFPagePDF

Feedback: Report problem or ask question.

MBS REAL studio tutorial videos - Nachhilfe in Eich