Disable PDF Annotation Editing in Swift for iOS

1
//
2
//  Copyright © 2017-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 LockAnnotationsExample: Example {
12

13
    override init() {
14
        super.init()
15

16
        title = "Generate a new file with locked annotations"
17
        contentDescription = "Uses the annotation flags to create a locked copy."
18
        category = .annotations
19
        priority = 1000
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        let samplesURL = Bundle.main.resourceURL!.appendingPathComponent("Samples")
24
        let documentURL = samplesURL.appendingPathComponent(AssetName.annualReport.rawValue)
25
        let writableDocumentURL = documentURL.copyToDocumentDirectory()
26

27
        // Copy the document to the temp directory.
28
        let tempURL = FileHelper.temporaryPDFFileURL(prefix: "locked_\(writableDocumentURL.lastPathComponent)")
29
        if FileManager.default.fileExists(atPath: writableDocumentURL.path) {
30
            try? FileManager.default.copyItem(at: writableDocumentURL, to: tempURL)
31
        } else {
32
            try? FileManager.default.copyItem(at: documentURL, to: tempURL)
33
        }
34

35
        // Open the new file and modify the annotations to be locked.
36
        let document = Document(url: tempURL)
37
        document.annotationSaveMode = .embedded
38

39
        // Create at least one annotation if the document is currently empty.
40
        let allTypesButLinks = Annotation.Kind.all.subtracting(.link)
41
        let allAnnotations = document.annotationsForPage(at: 0, type: allTypesButLinks)
42
        if allAnnotations.isEmpty {
43
            let ink = InkAnnotation.sampleInkAnnotation(in: CGRect(x: 100.0, y: 100.0, width: 200.0, height: 200.0))
44
            ink.color = UIColor(red: 0.667, green: 0.279, blue: 0.748, alpha: 1.0)
45
            ink.pageIndex = 0
46
            document.add(annotations: [ink])
47
        }
48

49
        // Lock all annotations except links and forms/widgets.
50
        let allTypesButLinkAndForms = Annotation.Kind.all.subtracting([.link, .widget])
51
        for pageIndex in 0..<document.pageCount {
52
            let annotations = document.annotationsForPage(at: pageIndex, type: allTypesButLinkAndForms)
53
            for annotation in annotations {
54
                // Preserve existing flags, just set the locked and locked contents flags.
55
                annotation.flags.update(with: [.locked, .lockedContents])
56
            }
57
        }
58

59
        // Save the document.
60
        try? document.save()
61

62
        print("Locked file: \(tempURL.path)")
63

64
        let controller = PDFViewController(document: document)
65
        return controller
66
    }
67
}