MBS( "PDFKit.GetPDFPageImage"; /* Renders an image of a page in a PDF document. */$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.e.g. 1 */
$ImageType; /* Optional; The type of image to return. Either JPEG, PNG, GIF or BMP. Default is JPEG.e.g. "JPEG" */
$Filename; /* Optional; The filename to use for the picture. Default is "image" with the extension matching the image type.e.g. "test.jpg" */
$DPI; /* Optional; The DPI to use for the resolution of the image. Default is 72.e.g. 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.e.g. 1 */
$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.e.g. 0 */
Less

Parameters

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.