Add File Annotation to PDF in 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
class AddFileAnnotationWithEmbeddedFileExample: Example, PDFViewControllerDelegate, PDFDocumentPickerControllerDelegate {
12

13
    var pdfController: PDFViewController?
14
    var documentPickerController: PDFDocumentPickerController?
15
    var longPressedPoint: CGPoint?
16

17
    override init() {
18
        super.init()
19

20
        title = "Add and remove file annotations with embedded files from a custom menu item"
21
        contentDescription = "Adds new menu items that will create and delete file annotations at the selected position."
22
        category = .annotations
23
        priority = 65
24
    }
25

26
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
27
        let document = AssetLoader.writableDocument(for: .welcome, overrideIfExists: false)
28

29
        documentPickerController = PDFDocumentPickerController(directory: "/Bundle/Samples", includeSubdirectories: true, library: SDK.shared.library)
30
        documentPickerController?.delegate = self
31

32
        pdfController = PDFViewController(document: document)
33
        pdfController?.delegate = self
34
        return pdfController!
35
    }
36

37
    // MARK: - PDFViewControllerDelegate
38

39
    func pdfViewController(_ sender: PDFViewController, menuForCreatingAnnotationAt point: CGPoint, onPageView pageView: PDFPageView, appearance: EditMenuAppearance, suggestedMenu: UIMenu) -> UIMenu {
40
        let attachFileAction = UIAction(title: "Attach File", image: UIImage(systemName: "paperclip")) { [self] _ in
41
            // Store the long pressed point in PDF coordinates to be used to set the bounding box of the newly created file annotation.
42
            longPressedPoint = pageView.pdfCoordinateSpace.convert(point, from: pageView)
43
            // Present the document picker.
44
            sender.present(self.documentPickerController!, options: [.closeButton: true], animated: true, sender: nil)
45
        }
46
        // Prepend our custom action.
47
        return suggestedMenu
48
            .prepend([attachFileAction])
49
    }
50

51
    // MARK: - PDFDocumentPickerControllerDelegate
52

53
    func documentPickerController(_ controller: PDFDocumentPickerController, didSelect document: Document, pageIndex: PageIndex, search searchString: String?) {
54
        let fileURL = document.fileURL
55
        let fileDescription = document.fileURL?.lastPathComponent
56

57
        // Create the file annotation and its embedded file
58
        let fileAnnotation = FileAnnotation()
59
        fileAnnotation.pageIndex = pageIndex
60
        fileAnnotation.boundingBox = CGRect(x: (self.longPressedPoint?.x)!, y: (self.longPressedPoint?.y)!, width: 32, height: 32)
61
        let embeddedFile = EmbeddedFile(fileURL: fileURL!, fileDescription: fileDescription)
62
        fileAnnotation.embeddedFile = embeddedFile
63

64
        // Add the embedded file to the document.
65
        pdfController?.document?.add(annotations: [fileAnnotation])
66

67
        // Dismiss the document picker.
68
        controller.dismiss(animated: true, completion: nil)
69
    }
70
}