All functions
Mac OS X
Windows
Crossplatform
Server
Components
Guides
Statistic
New in version:
2.0
2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
2.9
3.0
3.1
3.2
PDFKit.GetPDFPageImage
Component: PDFKit
Version: 2.1
Mac OS X: Works
Windows: Not implemented.
Server: Works
MBS( "PDFKit.GetPDFPageImage"; PDF; Index; ImageType; Filename; DPI; box )
Parameters
| Parameter | Description | Example value |
|---|---|---|
| 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 PageCount-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 | The DPI to use for the resolution of the image. Default is 72. | 72 |
| 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 |
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.
Examples
Render page 2 of a PDF into a picture
MBS( "PDFKit.GetPDFPageImage"; $ref; 1; "jpeg"; 300; 1 )
Feedback: Report problem or ask question.
Links
MBS REAL studio tutorial videos - Bilder aus Nickenich
