Toggle PDF Form Field Highlight Color in Swift for iOS

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

13
    private weak var pdfController: PDFViewController?
14

15
    override init() {
16
        super.init()
17
        title = "Custom Form Highlight Color"
18
        contentDescription = "Shows how to toggle the form highlight color."
19
        category = .viewCustomization
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        let document = AssetLoader.document(for: "Form.pdf")
24
        // Start by not highlighting forms.
25
        document.updateRenderOptions(for: .all) {
26
            $0.interactiveFormFillColor = .clear
27
        }
28

29
        let image = SDK.imageNamed("highlight.png")!
30
        let toggleButton = UIBarButtonItem(image: image, style: .plain, target: self, action: #selector(toggleHighlight))
31

32
        let pdfController = PDFViewController(document: document)
33
        pdfController.navigationItem.rightBarButtonItems = [toggleButton]
34
        self.pdfController = pdfController
35
        return pdfController
36
    }
37

38
    // MARK: Actions
39

40
    @objc func toggleHighlight() {
41
        guard let pdfController = self.pdfController, let document = pdfController.document else {
42
            return
43
        }
44

45
        // Toggle between highlighted forms and clear forms.
46
        let currentColor = document.renderOptions(forType: .all).interactiveFormFillColor
47
        let highlightColor = UIColor.catalogAccent.withAlphaComponent(0.2)
48

49
        document.updateRenderOptions(for: .page) { options in
50
            options.interactiveFormFillColor = currentColor == .clear ? highlightColor : .clear
51
        }
52

53
        pdfController.reloadData()
54
    }
55
}