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

PDFKit.Open

Opens a PDF and returns a PDF Reference value.

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

Parameters

Parameter Description Example
PDF A container value with the PDF content from a media field. Or a text with an URL.

Result

Returns a number for the PDF. Use PDFKit.Release later to free the memory.

Description

Opens a PDF and returns a PDF Reference value.
This value can be used in other PDFKit calls to work on the same PDF.
See also PDFKit.OpenContainer, PDFKit.OpenPath and PDFKit.OpenURL.
PDF Document reference numbers are starting at 30000 and counting up for each new document.

If you need to open a PDF file in the PDF Viewer, please use Files.LaunchFile with the path to the PDF file instead.

Examples

Open the PDF from the container value:

MBS("PDFKit.Open"; myTable::myMediaField)

See also

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 13th May 2019


PDFKit.NewPDFDocument - PDFKit.OpenContainer