PSPDFAnnotationFlags

Objective-C

enum PSPDFAnnotationFlags {}

Swift

struct Flag : OptionSet

A set of flags specifying various characteristics of the annotation. PSPDFKit doesn’t support all of those flag settings.

  • If set, ignore annotation AP stream if there is no handler available.

    Declaration

    Objective-C

    PSPDFAnnotationFlagInvisible = 1 << 0

    Swift

    static var invisible: Annotation.Flag { get }
  • If set, do not display or print the annotation or allow it to interact with the user.

    Declaration

    Objective-C

    PSPDFAnnotationFlagHidden = 1 << 1

    Swift

    static var hidden: Annotation.Flag { get }
  • If set, print the annotation when the page is printed.

    Declaration

    Objective-C

    PSPDFAnnotationFlagPrint = 1 << 2

    Swift

    static var print: Annotation.Flag { get }
  • [IGNORED] If set, don’t scale the annotation’s appearance to match the magnification of the page.

    Declaration

    Objective-C

    PSPDFAnnotationFlagNoZoom = 1 << 3

    Swift

    static var noZoom: Annotation.Flag { get }
  • [IGNORED] If set, don’t rotate the annotation’s appearance to match the rotation of the page.

    Declaration

    Objective-C

    PSPDFAnnotationFlagNoRotate = 1 << 4

    Swift

    static var noRotate: Annotation.Flag { get }
  • If set, don’t display the annotation on the screen. (But printing might be allowed)

    Declaration

    Objective-C

    PSPDFAnnotationFlagNoView = 1 << 5

    Swift

    static var noView: Annotation.Flag { get }
  • If set, don’t allow the annotation to interact with the user. Ignored for Widget annotations. For widget annotations its function is subsumed by the ReadOnly flag of the associated form field.

    Declaration

    Objective-C

    PSPDFAnnotationFlagReadOnly = 1 << 6

    Swift

    static var readOnly: Annotation.Flag { get }
  • If set, don’t allow the annotation to be deleted or properties modified, including contents. This does not apply to changes to a form field’s contents, however.

    Declaration

    Objective-C

    PSPDFAnnotationFlagLocked = 1 << 7

    Swift

    static var locked: Annotation.Flag { get }
  • [IGNORED] If set, invert the interpretation of the NoView flag for certain events.

    Declaration

    Objective-C

    PSPDFAnnotationFlagToggleNoView = 1 << 8

    Swift

    static var toggleNoView: Annotation.Flag { get }
  • If set, don’t allow the contents of the annotation to be modified by the user.

    Declaration

    Objective-C

    PSPDFAnnotationFlagLockedContents = 1 << 9

    Swift

    static var lockedContents: Annotation.Flag { get }