Write PDF Annotations to XFDF 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 AnnotationsXFDFWritingExample: Example {
12
    override init() {
13
        super.init()
14
        title = "XFDF Writing"
15
        contentDescription = "Creates annotations in code and exports them as XFDF."
16
        category = .annotations
17
        priority = 900
18
    }
19

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

23
        let docsFolder = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
24
        let fileXML = docsFolder.appendingPathComponent("XFDFTest.xfdf")
25
        print("fileXML: \(fileXML.path)")
26

27
        // Collect all existing annotations from the document
28
        let tempDocument = Document(url: documentURL)
29
        var annotations = [Annotation]()
30

31
        let linkAnnotation = LinkAnnotation(url: URL(string: "https://www.nutrient.io/")!)
32
        linkAnnotation.boundingBox = CGRect(x: 100, y: 80, width: 200, height: 300)
33
        linkAnnotation.pageIndex = 1
34
        annotations.append(linkAnnotation)
35

36
        let aStream = LinkAnnotation(url: URL(string: "pspdfkit://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8")!)
37
        aStream.boundingBox = CGRect(x: 100, y: 100, width: 200, height: 300)
38
        aStream.pageIndex = 0
39
        annotations.append(aStream)
40

41
        let anImage = LinkAnnotation(url: URL(string: "pspdfkit://ramitia.files.wordpress.com/2011/05/durian1.jpg")!)
42
        anImage.boundingBox = CGRect(x: 100, y: 100, width: 200, height: 300)
43
        anImage.pageIndex = 3
44
        annotations.append(anImage)
45

46
        print("annotations: \(annotations)")
47

48
        // Write the annotations to the XFDF File.
49
        do {
50
            let dataSink = try FileDataSink(fileURL: fileXML)
51
            try XFDFWriter().write(annotations, to: dataSink, documentProvider: tempDocument.documentProviders.first!)
52
        } catch {
53
            print("Failed while coping the existing XFDF file: \(error.localizedDescription)")
54
        }
55

56
        // Create document and set up the XFDF provider
57
        let document = Document(url: documentURL)
58
        document.didCreateDocumentProviderBlock = { documentProvider in
59
            let XFDFProvider = XFDFAnnotationProvider(documentProvider: documentProvider, fileURL: fileXML)
60
            documentProvider.annotationManager.annotationProviders = [XFDFProvider]
61
        }
62

63
        return PDFViewController(document: document)
64
    }
65
}