Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
Renders an image of a page in a PDF document.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
PDFKit | 2.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
Parameter | Description | Example | Flags |
---|---|---|---|
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. |
0 | |
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 |
Returns a container with a JPEG picture of the PDF page. You can store it in a media field.
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" )
Make preview of page:
If [ MBS("IsWindows") ]
Set Variable [ $pdf ; Value: MBS( "WinPDF.LoadContainer"; Get Preview::Input) ]
If [ MBS("IsError") = 0 ]
Set Variable [ $NewImage ; Value: MBS( "WinPDF.PageImageAtSize"; $pdf; 0; 0; 600; "JPEG"; "page.jpg") ]
If [ MBS("IsError") = 0 ]
Set Field [ Get Preview::Preview ; $NewImage ]
Set Field [ Get Preview::Made using ; "WinPDF" ]
Set Variable [ $r ; Value: MBS( "WinPDF.Release"; $pdf) ]
Exit Script [ Text Result: ]
End If
Set Variable [ $r ; Value: MBS( "WinPDF.Release"; $pdf) ]
End If
Else If [ MBS("IsMacOS") or MBS("IsIOS") ]
Set Variable [ $preview ; Value: MBS( "PDFKit.GetPDFPageImage"; $Input; 0; "JPEG"; "input.jpg"; 72) ]
If [ MBS("IsError") = 0 ]
Set Field [ Get Preview::Preview ; $preview ]
Set Field [ Get Preview::Made using ; "PDFKit" ]
Exit Script [ Text Result: ]
End If
End If
This function checks for a license.
Created 18th August 2014, last changed 15th April 2023