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

PDFKit.AddEmptyPage

Adds an empty page to the given PDF document.

Component Version macOS Windows Linux Server iOS SDK
PDFKit 5.0 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "PDFKit.AddEmptyPage"; PDF { ; Width; Height } )   More

Parameters

Parameter Description Example Flags
PDF A PDF reference number from PDFKit.Open. $ref
Width The width for the new PDF page. 600 Optional
Height The height of the new PDF page. 800 Optional

Result

Returns OK or error.

Description

Adds an empty page to the given PDF document.

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

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)]

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 16th February 2015, last changed 28th September 2021


Overlay.SetVisible - PDFKit.AddImageFilePage