PSPDFAnnotationSummarizer


@interface PSPDFAnnotationSummarizer : NSObject

Generates an annotation summary.

  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFAnnotationSummarizer : NSObject
  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFAnnotationSummarizer : NSObject
  • Initialize the annotation summarizer with a document. - note: Will return nil if document is nil.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocument:(nonnull PSPDFDocument *)document;

    Swift

    init(document: PSPDFDocument)
  • The attached document.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFDocument *_Nonnull document;

    Swift

    var document: PSPDFDocument { get }
  • Generates an annotation summary for all pages in the current set document.

    Declaration

    Objective-C

    - (nonnull NSAttributedString *)annotationSummaryForPages:
        (nonnull NSIndexSet *)pages;

    Swift

    func annotationSummary(forPages pages: IndexSet) -> NSAttributedString
  • Generates a .txt file containing the annotation summary as a plain string.

    Declaration

    Objective-C

    - (nullable NSURL *)temporaryTextFileURLForPages:(nonnull NSIndexSet *)pages
                                               error:(NSError *_Nullable *_Nullable)
                                                         error;

    Swift

    func temporaryTextFileURL(forPages pages: IndexSet) throws -> URL
  • Generates a .txt file contains the annotations summary as a plain string.

    Declaration

    Objective-C

    + (nullable NSURL *)
    temporaryTextFileURLForDocuments:(nonnull NSArray<PSPDFDocument *> *)documents
                               error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func temporaryTextFileURL(for documents: [PSPDFDocument]) throws -> URL
  • Generates an annotation summary for all pages in the given documents.

    Declaration

    Objective-C

    + (nonnull NSAttributedString *)annotationSummaryForDocuments:
        (nonnull NSArray<PSPDFDocument *> *)documents;

    Swift

    class func annotationSummary(for documents: [PSPDFDocument]) -> NSAttributedString