| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
PDFKit.CombineRef
Creates a new PDF document with all the given PDF files/references and returns the new PDF reference.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| PDFKit | 2.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
MBS( "PDFKit.CombineRef"; Name; PDFs... ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| Name | A text with the file name to include with the PDF. | "test.pdf" |
| PDFs... | Several PDF references. A container value with the PDF content from a media field. Or a text with an URL. Or a PDF reference from PDFKit.Open. |
Result
Returns the PDF reference.
Description
Creates a new PDF document with all the given PDF files/references and returns the new PDF reference.You can pass container values, URLs or PDF references. You can pass one PDF reference to save to a new PDF.
Please note the difference between PDFKit.Combine and PDFKit.CombineRef. Combine returns a new container value with the new PDF. CombineRef returns the new PDF reference for further processing.
If on combining one of the PDF parameters is not a valid PDF, the function returns an error. You can use PDFKit.SetIgnoreCombineErrors to disable that and ignore all PDFs which fail to open. For example if you write code which takes 4 container values and not all of them contain PDF files.
Starting with version 6.0, the PDFs parameters can also be lists of paths or reference numbers.
This function takes variable number of parameters. Pass as much parameters as needed separated by the semicolon in FileMaker.
Please repeat PDFs parameter as often as you need.
Examples
Combine the PDF files in the three PDF references into a new PDF reference:
MBS("PDFKit.CombineRef"; ""; $ref1; $ref2; $ref3)
See also
Blog Entries
FileMaker Magazin
This function is free to use.
Created 18th August 2014, last changed 5th June 2021
