Import & Export Annotations in XFDF using Swift for iOS

1
//
2
//  Copyright © 2014-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
// MARK: - XFDF Annotation Provider
12

13
class XFDFAnnotationProviderExample: Example {
14

15
    override init() {
16
        super.init()
17
        title = "XFDF Annotation Provider"
18
        contentDescription = "XFDF is an XML-based Adobe standard and is well suited for importing and exporting for integration with third-party PDF applications."
19
        category = .annotationProviders
20
        priority = 80
21
    }
22

23
    // This example shows how you can create an XFDF provider instead of the default file-based one.
24
    // XFDF is an industry standard and the file will be interoperable with Adobe Acrobat or any other standards-compliant PDF framework.
25
    override func invoke(with delegate: ExampleRunnerDelegate?) -> UIViewController? {
26
        let documentURL = AssetLoader.assetURL(for: .annualReport)
27

28
        // Load from an example XFDF file.
29
        let docsFolder = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
30
        let fileXML = docsFolder.appendingPathComponent("XFDFTest.xfdf")
31
        print("Using XFDF file at \(fileXML.path)")
32

33
        // DEBUG HELPER: Delete the existing file.
34
        // try? FileManager.default.removeItem(at: fileXML)
35

36
        // Create an example XFDF from the current document if one doesn't already exist.
37
        if !FileManager.default.fileExists(atPath: fileXML.path) {
38
            // Collect all existing annotations from the document.
39
            let tempDocument = Document(url: documentURL)
40
            let annotations = tempDocument.allAnnotations(of: .all).values.flatMap { $0 }
41

42
            // Write the annotations to the disk creating a new XFDF file.
43
            do {
44
                let dataSink = try FileDataSink(fileURL: fileXML)
45
                try XFDFWriter().write(annotations, to: dataSink, documentProvider: tempDocument.documentProviders.first!)
46
            } catch {
47
                print("Failed to write XFDF file: \(error.localizedDescription)")
48
                return nil
49
            }
50
        }
51

52
        // Create document and set up the XFDF provider.
53
        let document = Document(url: documentURL)
54
        document.annotationSaveMode = .externalFile
55
        document.didCreateDocumentProviderBlock = { documentProvider in
56
            let XFDFProvider = XFDFAnnotationProvider(documentProvider: documentProvider, fileURL: fileXML)
57
            // 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
58
            // provider to the annotation manager's `annotationProviders` array:
59
            //
60
            // let fileProvider = documentProvider.annotationManager.fileAnnotationProvider!
61
            // documentProvider.annotationManager.annotationProviders = [XFDFProvider, fileProvider]
62

63
            documentProvider.annotationManager.annotationProviders = [XFDFProvider]
64
        }
65

66
        let controller = PDFViewController(document: document)
67

68
        let saveButton = UIBarButtonItem(title: "Save", primaryAction: UIAction { _ in
69
            document.save { result in
70

71
                switch result {
72
                case .success:
73
                    let attributes = try? Foundation.FileManager.default.attributesOfItem(atPath: fileXML.path)
74
                    let XFDFFileSize = attributes?[.size] as? UInt64 ?? 0
75
                    print("Saving done. (XFDF file size: \(XFDFFileSize) bytes)")
76

77
                case .failure(let error):
78
                    print("Saving failed: \(error.localizedDescription)")
79
                }
80
            }
81
        })
82
        controller.navigationItem.leftBarButtonItems = [controller.closeButtonItem, saveButton]
83
        return controller
84
    }
85
}