Programtically Search a PDF using 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 SearchWithoutControllerExample: Example {
12

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

16
        title = "Headless Search Example"
17
        contentDescription = "Search programmatically without displaying search controller."
18
        category = .subclassing
19
        priority = 140
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        let document = AssetLoader.document(for: .welcome)
24
        let pdfController = HeadlessSearchPDFViewController(document: document)
25
        pdfController.highlightedSearchText = "PSPDFKit"
26
        return pdfController
27
    }
28
}
29

30
private class HeadlessSearchPDFViewController: PDFViewController, PDFViewControllerDelegate {
31

32
    var highlightedSearchText: String? {
33
        didSet {
34
            if oldValue != highlightedSearchText {
35
                updateTextHighlight()
36
            }
37
        }
38
    }
39

40
    override func commonInit(with document: Document?, configuration: PDFConfiguration) {
41
        super.commonInit(with: document, configuration: configuration.configurationUpdated {
42
            // Register the override to use a custom search highlight view subclass.
43
            $0.overrideClass(SearchHighlightView.self, with: NonAnimatingSearchHighlightView.self)
44
        })
45

46
        // We are using the delegate to be informed about page loads.
47
        delegate = self
48
    }
49

50
    // MARK: - PSPDFViewControllerDelegate
51

52
    func pdfViewController(_ pdfController: PDFViewController, didConfigurePageView pageView: PDFPageView, forPageAt pageIndex: Int) {
53
        // Restart search if we have a new pageView loaded.
54
        updateTextHighlight()
55
    }
56

57
    // MARK: - Private
58

59
    private func updateTextHighlight() {
60
        search(for: highlightedSearchText, options: [PresentationOption.searchHeadless: NSNumber(value: true)], sender: nil, animated: false)
61
    }
62
}
63

64
private class NonAnimatingSearchHighlightView: SearchHighlightView {
65

66
    override func popupAnimation() {
67
        // No Operation: We do not want to perform an animation.
68
    }
69
}