Apply XFDF Annotations & Save it as New PDF in Swift for iOS

1
//
2
//  Copyright © 2021-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
class XFDFAnnotationProviderEmbeddedExample: Example {
12

13
    override init() {
14
        super.init()
15
        title = "XFDF Annotation Provider - Generate new file"
16
        contentDescription = "Generating a new file with XFDF annotations using PSPDFProcessor"
17
        category = .annotationProviders
18
        priority = 90
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate?) -> UIViewController? {
22
        let documentURL = AssetLoader.assetURL(for: .annualReport)
23

24
        let docsFolder = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
25
        let outputURL = docsFolder.appendingPathComponent("OutputAsset.pdf")
26

27
        // Load from an example XFDF file.
28
        let fileXML = docsFolder.appendingPathComponent("XFDFTest.xfdf")
29
        print("Using XFDF file at \(fileXML.path)")
30

31
        // Create document and set up the XFDF provider.
32
        let document = Document(url: documentURL)
33
        document.didCreateDocumentProviderBlock = { documentProvider in
34
            let XFDFProvider = XFDFAnnotationProvider(documentProvider: documentProvider, fileURL: fileXML)
35
            // Note that if the document you're opening has form fields which you wish to be usable when using XFDF, you should also add the file annotation
36
            // provider to the annotation manager's `annotationProviders` array:
37
            //
38
            // let fileProvider = documentProvider.annotationManager.fileAnnotationProvider!
39
            // documentProvider.annotationManager.annotationProviders = [XFDFProvider, fileProvider]
40

41
            documentProvider.annotationManager.annotationProviders = [XFDFProvider]
42
        }
43

44
        let controller = PDFViewController(document: document)
45

46
        let saveButton = UIBarButtonItem(title: "Save", primaryAction: UIAction { _ in
47
            // Generate a new document with embedded annotations
48
            let config = Processor.Configuration(document: document)!
49
            config.modifyAnnotations(ofTypes: .all, change: .embed)
50

51
            // The processor doesn't overwrite files, so we remove the document.
52
            try? FileManager.default.removeItem(at: outputURL)
53

54
            let processor = Processor(configuration: config, securityOptions: nil)
55
            do {
56
                try processor.write(toFileURL: outputURL)
57
                print("Saved file to: \(outputURL)")
58
            } catch {
59
                print("Failed saving file to: \(outputURL). Error: \(error.localizedDescription)")
60
            }
61
        })
62
        controller.navigationItem.leftBarButtonItems = [controller.closeButtonItem, saveButton]
63
        return controller
64
    }
65
}