Topics   All   Mac OS X (Only)   Windows (Only)   Crossplatform   Server   Client   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   5.2   5.3   5.4  


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.
Filename Optional
The filename to use for the picture. Default is "image" with the extension matching the image type.
DPI Optional
The DPI to use for the resolution of the image. Default is 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.
ClearBackground Optional
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.


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.

For Windows, please check DynaPDF.GeneratePreview function.


Render page 2 of a PDF into a picture

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

Render first page of a PDF in a container:

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

See also

PDFKit.GetPDFPageFormattedText   -   PDFKit.GetPDFPagePDF

Feedback: Report problem or ask question.

MBS REALbasic Plugins - Nachhilfe in Kruft