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

PDFKit.AppendPages

Copies pages from one PDF to append other PDF.

Component Version macOS Windows Linux Server iOS SDK
PDFKit 3.1 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "PDFKit.AppendPages"; PDFRef; OtherPDFs )   More

Parameters

Parameter Description Example
PDFRef The PDF Reference where pages are added. $ref
OtherPDFs 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. $PDF

Result

Returns OK on success or error on failure.

Description

Copies pages from one PDF to append other PDF.

Your changes are only done in memory, so please remember to write modified pdf back to disk, e.g. by using PDFKit.WriteToPath. Or use PDFKit.GetPDFDocument to get a PDF for storing in a container.

Examples

Merge two PDFs:

Set Variable [ $pdf ; Value: MBS("PDFKit.OpenContainer"; MyTable::InputPDF) ]
Set Variable [ $r ; Value: MBS( "PDFKit.AppendPages"; $pdf; MyTable::OtherPDF ) ]
Set Field [ MyTable::OutputPDF ; MBS( "PDFKit.GetPDFDocument"; $PDF) ]
Set Variable [ $r ; Value: MBS( "PDFKit.Release"; $pdf) ]

Loop over PDF documents in records and import them into a new PDF and add empty pages between:

Go to Record/Request/Page [ First ]
Set Variable [ $pdf ; Value: MBS( "PDFKit.NewPDFDocument" ) ]
Loop
    Set Variable [ $r ; Value: MBS( "PDFKit.AppendPages"; $pdf; Merge PDFs::InputPDF) ]
    Set Variable [ $r ; Value: MBS( "PDFKit.AddEmptyPage"; $pdf; 700; 500) ]
    Go to Record/Request/Page [ Next ; Exit after last: On ]
End Loop
Set Field [ Merge PDFs::FinalPDF ; MBS("PDFKit.GetPDFDocument"; $pdf) ]
Set Variable [ $r ; Value: MBS("PDFKit.Release"; $pdf) ]

See also

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 28th September 2021


PDFKit.AddImagePage - PDFKit.Combine