Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Creates a new PDF Document with the given PDF document.

Component Version macOS Windows Linux Server iOS SDK
PDFKit 2.2 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "PDFKit.GetPDFDocument"; PDF { ; Filename } )   More


Parameter Description Example Flags
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.
Filename Optionally, the file name to use for the container value. "output.pdf" Optional


Returns a container with a PDF document. The plugin adds a JPEG picture for preview as well as a file name. You can store it in a media field.


Creates a new PDF Document with the given PDF document.
Filename is optional. When you use an URL for the PDF, you can basically load a new PDF from a server.
See Plugin.SetPreviewSize to control size of preview picture.


Save a PDF in a PDF reference into a container value:

MBS( "PDFKit.GetPDFDocument"; $ref; "test.pdf" )

Create PDF from images:

# Start new document
Set Variable [$doc; Value:MBS("PDFKit.NewPDFDocument")]
# Add image in full size as new page
Set Variable [$r; Value:MBS("PDFKit.AddImagePage"; $doc; test::image)]
# Add empty page in default size
Set Variable [$r; Value:MBS("PDFKit.AddEmptyPage"; $doc)]
# Add image in given size as new page:
Set Variable [$r; Value:MBS("PDFKit.AddImagePage"; $doc; test::image; 400; 300)]
# get PDF document and store in container:
Set Field [test::test; MBS("PDFKit.GetPDFDocument"; $doc)]
# release memory
Set Variable [$r; Value:MBS("PDFKit.Release"; $doc)]

See also

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 4th October 2021

PDFKit.GetPDFAttribute - PDFKit.GetPDFPageCount