Redact Text in PDF using Swift for iOS

1
//
2
//  Copyright © 2018-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
final class RedactionExample: Example {
12

13
    // MARK: Lifecycle
14

15
    override init() {
16
        super.init()
17

18
        title = "Redaction"
19
        contentDescription = "Shows how to redact text with Processor."
20
        category = .documentProcessing
21
        priority = 12
22
    }
23

24
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
25
        let document = AssetLoader.document(for: .welcome)
26
        // Change the UID so the annotations we add in this example
27
        // don't show up in other examples using this document,
28
        // and are saved to an external file.
29
        document.uid = "Welcome Redaction"
30

31
        // If there are any existing redact annotations, remove them.
32
        let existingRedactAnnotations = document.annotations(at: 0, type: RedactionAnnotation.self)
33
        document.remove(annotations: existingRedactAnnotations)
34

35
        // Add a redact annotation over the word 'Welcome' on the first page.
36
        if let textParser = document.textParserForPage(at: 0),
37
            let wordToRedact = textParser.words.first(where: { $0.stringValue == "Welcome" }) {
38

39
            let redactionRect = wordToRedact.frame
40

41
            let redaction = RedactionAnnotation()
42
            redaction.boundingBox = redactionRect
43
            redaction.rects = [redactionRect]
44
            redaction.color = .orange
45
            redaction.fillColor = .black
46
            redaction.outlineColor = .green
47
            redaction.overlayText = "REDACTED"
48

49
            document.add(annotations: [redaction])
50
        }
51

52
        return RedactionPDFViewController(document: document)
53
    }
54

55
    final class RedactionPDFViewController: PDFViewController {
56
        override func commonInit(with document: Document?, configuration: PDFConfiguration) {
57
            super.commonInit(with: document, configuration: configuration)
58

59
            let redactButton = UIBarButtonItem(title: "Redact", style: .plain, target: self, action: #selector(applyRedactions))
60

61
            navigationItem.setRightBarButtonItems([annotationButtonItem, activityButtonItem, outlineButtonItem, redactButton], for: .document, animated: false)
62
        }
63

64
        @objc func applyRedactions() {
65
            let processorConfiguration = Processor.Configuration(document: document)!
66
            processorConfiguration.applyRedactions()
67

68
            let redactedDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "redacted")
69
            let processor = Processor(configuration: processorConfiguration, securityOptions: nil)
70
            try! processor.write(toFileURL: redactedDocumentURL)
71

72
            self.document = Document(url: redactedDocumentURL)
73
        }
74
    }
75
}