Other Constants

The following constants are available globally.

  • In the old legacy file format the default number of PBKDF rounds is 50000. The new default is PSPDFAESDefaultPBKDFNumberOfRounds. (10000)

    Declaration

    Objective-C

    extern const NSUInteger PSPDFDefaultPBKDFNumberOfRounds

    Swift

    let PSPDFDefaultPBKDFNumberOfRounds: UInt
  • The PSPDFAESCryptoInputStream Error Domain.

    Note

    Used in the PSPDFAESCryptoInputStream -(NSError *)streamError method.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAESCryptoInputStreamErrorDomain

    Swift

    let PSPDFAESCryptoInputStreamErrorDomain: String
  • The PSPDFAESCryptoOutputStream Error Domain.

    Note

    Used in the PSPDFAESCryptoOutputStream -(NSError *)streamError method.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAESCryptoOutputStreamErrorDomain

    Swift

    let PSPDFAESCryptoOutputStreamErrorDomain: String
  • Set to @YES in the options dictionary to make links modal.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionModalKey

    Swift

    let PSPDFActionOptionModalKey: String
  • Enable Autoplay if target is a video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionAutoplayKey

    Swift

    let PSPDFActionOptionAutoplayKey: String
  • Enable/Disable controls. (e.g. Browser back/next buttons)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionControlsKey

    Swift

    let PSPDFActionOptionControlsKey: String
  • Loop the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionLoopKey

    Swift

    let PSPDFActionOptionLoopKey: String
  • Allow fullscreen presentation.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionFullscreenKey

    Swift

    let PSPDFActionOptionFullscreenKey: String
  • Set video offset.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionOffsetKey

    Swift

    let PSPDFActionOptionOffsetKey: String
  • Set modal size.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionSizeKey

    Swift

    let PSPDFActionOptionSizeKey: String
  • Show as popover.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionPopoverKey

    Swift

    let PSPDFActionOptionPopoverKey: String
  • Show cover, accepts string path.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionCoverKey

    Swift

    let PSPDFActionOptionCoverKey: String
  • The target page.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionPageKey

    Swift

    let PSPDFActionOptionPageKey: String
  • Shows a button that activates links.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionButtonKey

    Swift

    let PSPDFActionOptionButtonKey: String
  • Controls if a close button is displayed, when PSPDFActionOptionButtonKey is used. Default will be YES.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionCloseButtonKey

    Swift

    let PSPDFActionOptionCloseButtonKey: String
  • Constant to convert PSPDFActionType into NSString and back.

    Note

    The transformer is added in the class initialize phase. Requires PSPDFAnnotation to be accessed at least once.

    Declaration

    Objective-C

    extern const PSPDFValueTransformerName _Nonnull PSPDFActionTypeTransformerName

    Swift

    static let actionTypeTransformerName: PSPDFValueTransformerName
  • Prefix used for all analytics events. pspdf. A underscore (_) is added after this prefix to all analytics events as well.

    Declaration

    Objective-C

    extern NSString *const PSPDFAnalyticsEventPrefix

    Swift

    let PSPDFAnalyticsEventPrefix: String
  • Links and PSPDFKit multimedia extensions.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringLink

    Swift

    static let link: AnnotationString
  • Highlight annotation. Can be used to highlight text.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringHighlight

    Swift

    static let highlight: AnnotationString
  • Strikeout annotation. Can be used to strikethrough text.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringStrikeOut

    Swift

    static let strikeOut: AnnotationString
  • Underline annotation. Can be used to underline text.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringUnderline

    Swift

    static let underline: AnnotationString
  • Squiggly annotation. Can be used to squiggly underline text.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSquiggly

    Swift

    static let squiggly: AnnotationString
  • Note annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringNote

    Swift

    static let note: AnnotationString
  • Free text annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringFreeText

    Swift

    static let freeText: AnnotationString
  • Ink annotation. Drawing. Includes ink signatures.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringInk

    Swift

    static let ink: AnnotationString
  • Square annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSquare

    Swift

    static let square: AnnotationString
  • Circle annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringCircle

    Swift

    static let circle: AnnotationString
  • Line annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringLine

    Swift

    static let line: AnnotationString
  • Polygon annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPolygon

    Swift

    static let polygon: AnnotationString
  • Polyline annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPolyLine

    Swift

    static let polyLine: AnnotationString
  • Signature annotation. Is a PSPDFAnnotationStringInk annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSignature

    Swift

    static let signature: AnnotationString
  • Stamp annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringStamp

    Swift

    static let stamp: AnnotationString
  • Special type of annotation that allows you to (partially) erase (ink annotation) drawings.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringEraser

    Swift

    static let eraser: AnnotationString
  • Sound annotation. Can be played back and recorded by default, but by default playback and recording will not work when the host app is in the background. If you want to enable background playback and recording, you’ll need to add the audio entry to the UIBackgroundModes array in the app’s Info.plist. If you do not add this, then recording will be stopped and playback will be silenced when your app is sent into the background.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSound

    Swift

    static let sound: AnnotationString
  • Image annotation. Is a PSPDFAnnotationStringStamp annotation. UIImagePickerController will be used to pick an image. This will throw a UIApplicationInvalidInterfaceOrientation exception if your app does not include portrait in UISupportedInterfaceOrientations (Info.plist). For landscape only apps, we suggest enabling portrait orientation(s) in your Info.plist and rejecting these in UIViewController’s auto-rotation methods. This way, you can be landscape only for your view controllers and still be able to use UIImagePickerController.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringImage

    Swift

    static let image: AnnotationString
  • Redaction annotation.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringRedaction

    Swift

    static let redaction: AnnotationString
  • Widget annotation. Includes PDF Forms. Non-writable annotation type.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringWidget

    Swift

    static let widget: AnnotationString
  • File attachment. Non-writable annotation type.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringFile

    Swift

    static let file: AnnotationString
  • Embedded PDF video. Non-writable annotation type.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringRichMedia

    Swift

    static let richMedia: AnnotationString
  • Embedded PDF video. Non-writable annotation type.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringScreen

    Swift

    static let screen: AnnotationString
  • Caret annotation. Non-writable annotation type.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringCaret

    Swift

    static let caret: AnnotationString
  • Popup annotation. Placeholder. Not yet supported.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPopup

    Swift

    static let popup: AnnotationString
  • Watermark annotation. Placeholder. Not yet supported.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringWatermark

    Swift

    static let watermark: AnnotationString
  • TrapNet annotation. Placeholder. Not yet supported.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringTrapNet

    Swift

    static let trapNet: AnnotationString
  • 3D annotation. Placeholder. Not yet supported.

    Declaration

    Objective-C

    extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationString3D

    Swift

    static let string3D: AnnotationString
  • NSValueTransformer to convert between PSPDFAnnotationBorderStyle enum and string value.

    Note

    The transformer is added in the class initialize phase. Requires PSPDFAnnotation to be accessed at least once.

    Declaration

    Objective-C

    extern const PSPDFValueTransformerName _Nonnull PSPDFBorderStyleTransformerName

    Swift

    static let borderStyleTransformerName: PSPDFValueTransformerName
  • NSValueTransformer to convert between PSPDFAnnotationBorderEffect enum and string value.

    Note

    The transformer is added in the class initialize phase. Requires PSPDFAnnotation to be accessed at least once.

    Declaration

    Objective-C

    extern const PSPDFValueTransformerName _Nonnull PSPDFBorderEffectTransformerName

    Swift

    static let borderEffectTransformerName: PSPDFValueTransformerName
  • NSValueTransformer to convert between PSPDFAnnotationTriggerEvent enum and string value.

    Note

    The transformer is added in the class initialize phase. Requires PSPDFAnnotation to be accessed at least once.

    Declaration

    Objective-C

    extern const PSPDFValueTransformerName _Nonnull PSPDFAnnotationTriggerEventTransformerName

    Swift

    static let annotationTriggerEventTransformerName: PSPDFValueTransformerName
  • Default value for non-fixed-sized annotations

    Declaration

    Objective-C

    extern const CGSize PSPDFAnnotationFixedSizeDisabled

    Swift

    let PSPDFAnnotationFixedSizeDisabled: CGSize
  • Options to use for drawInContext:withOptions:

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAnnotationDrawFlattenedKey

    Swift

    let PSPDFAnnotationDrawFlattenedKey: String
  • Set to @YES to specify that the annotation is being drawn for printing.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAnnotationDrawForPrintingKey

    Swift

    let PSPDFAnnotationDrawForPrintingKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFAnnotationDrawCenteredKey

    Swift

    let PSPDFAnnotationDrawCenteredKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFAnnotationMarginKey

    Swift

    let PSPDFAnnotationMarginKey: String
  • Key for attributed string attribute that contains the font size - this is set if the font size is defined.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFFontSizeName

    Swift

    let PSPDFFontSizeName: String
  • Key for vertical text alignment in fontAttributes.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFVerticalAlignmentName

    Swift

    let PSPDFVerticalAlignmentName: String
  • Key for the original font name when a fallback font is used to draw the the annotation’s content.

    When the font specified for an annotation with text contents isn’t available on the device, a fallback font will be used to render that text. In order to preserve this data, even when updating other aspects of the annotation, the original font name will be stored as an NSString under this key in the fontAttributes dictionary of the annotation while the fallback is in effect.

    As PSPDFKit will attempt to load the original font when possible, this value may be cleared later when the font has successfully been downloaded, and display of the annotation updated accordingly.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFOriginalFontNameAttributeName

    Swift

    let PSPDFOriginalFontNameAttributeName: String
  • Constant to convert PSPDFVerticalAlignment into NSString and back.

    Note

    The transformer is added in the class initialize phase. Requires PSPDFAnnotation to be accessed at least once.

    Declaration

    Objective-C

    extern const PSPDFValueTransformerName _Nonnull PSPDFVerticalAlignmentTransformerName

    Swift

    static let verticalAlignmentTransformerName: PSPDFValueTransformerName
  • Notification posted on the main thread when new annotations are added to the default PSPDFFileAnnotationProvider. The notification object is an NSArray containing the new PSPDFAnnotations.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationsAddedNotification

    Swift

    static let PSPDFAnnotationsAdded: NSNotification.Name
  • Notification posted on the main thread when annotations are removed from the default PSPDFFileAnnotationProvider. The notification object is an NSArray containing the removed PSPDFAnnotations.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationsRemovedNotification

    Swift

    static let PSPDFAnnotationsRemoved: NSNotification.Name
  • Internal events to notify the annotation providers when annotations are being changed.

    Warning

    Only send from main thread! Don’t call save during a change notification.

    Note

    The notification’s object property is a PSPDFAnnotation instance.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationChangedNotification

    Swift

    static let PSPDFAnnotationChanged: NSNotification.Name
  • Set to YES to disable handling by views.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFAnnotationChangedNotificationIgnoreUpdateKey

    Swift

    let PSPDFAnnotationChangedNotificationIgnoreUpdateKey: String
  • NSArray of selector names.

    Note

    Properties will be prefixed with ‘is’ in Objective-C. For example, the deleted property becomes isDeleted.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAnnotationChangedNotificationKeyPathKey

    Swift

    let PSPDFAnnotationChangedNotificationKeyPathKey: String
  • Controls if overlay annotations should be animated. Only applies to overlay. Defaults to YES if not explicitly set to NO.

    Note

    This is defined on the model layer to allow passing through animated: parameters.

    Declaration

    Objective-C

    extern const PSPDFAnnotationOption _Nonnull PSPDFAnnotationOptionAnimateViewKey

    Swift

    static let animateViewKey: PSPDFAnnotationOption
  • Prevents the insertion or removal notifications from being sent (use a BOOL NSNumber value).

    Declaration

    Objective-C

    extern const PSPDFAnnotationOption _Nonnull PSPDFAnnotationOptionSuppressNotificationsKey

    Swift

    static let suppressNotificationsKey: PSPDFAnnotationOption
  • Fired whenever the toolbar visibility changes.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationToolbarControllerVisibilityDidChangeNotification

    Swift

    static let PSPDFAnnotationToolbarControllerVisibilityDidChange: NSNotification.Name
  • Key inside the notification’s userInfo.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFAnnotationToolbarControllerVisibilityAnimatedKey

    Swift

    let PSPDFAnnotationToolbarControllerVisibilityAnimatedKey: String
  • Notification sent out after appearanceMode is changed.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAppearanceModeChangedNotification

    Swift

    static let PSPDFAppearanceModeChanged: NSNotification.Name
  • Notification userInfo dictionary key. Holds a BOOL NSNumber which is YES when an animated mode change was requested.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAppearanceModeChangedAnimatedKey

    Swift

    let PSPDFAppearanceModeChangedAnimatedKey: String
  • Notification posted on the main thread whenever detected is set to YES even if it was YES before.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFApplePencilDetectedNotification

    Swift

    static let PSPDFApplePencilDetected: NSNotification.Name
  • Notification posted on the main thread whenever detected changes value.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFApplePencilDetectedChangedNotification

    Swift

    static let PSPDFApplePencilDetectedChanged: NSNotification.Name
  • Register to get notified when the bookmarks managed by the bookmark manager posting this notification change.

    A change is defined as adding, removing, or replacing a bookmark or changing its sort order.

    This notification is guaranteed to be posted on the main thread.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFBookmarksChangedNotification

    Swift

    static let PSPDFBookmarksChanged: NSNotification.Name
  • The priority with which the filterElement is centered inside the filter view.

    Declaration

    Objective-C

    static const UILayoutPriority PSPDFCollectionReusableFilterViewCenterPriority =
        UILayoutPriorityDefaultHigh - 10

    Swift

    static let PSPDFCollectionReusableFilterViewCenterPriority: UILayoutPriority
  • The default minimum margin of the filterElement

    Declaration

    Objective-C

    static const CGFloat PSPDFCollectionReusableFilterViewDefaultMargin = 8

    Swift

    let PSPDFCollectionReusableFilterViewDefaultMargin: CGFloat
  • Use on searchResultZoomScale for an automatic scale mode that makes text readable in most cases.

    Declaration

    Objective-C

    extern const CGFloat PSPDFAutomaticSearchResultZoomScale

    Swift

    let PSPDFAutomaticSearchResultZoomScale: CGFloat
  • Pre-provided activity that shows the open in view controller.

    Declaration

    Objective-C

    extern const UIActivityType _Nonnull PSPDFActivityTypeOpenIn

    Swift

    static let PSPDFActivityTypeOpenIn: UIActivity.ActivityType
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFCryptorErrorDomain
  • Search glyphs.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsGlyphsKey

    Swift

    let PSPDFObjectsGlyphsKey: String
  • Always return full PSPDFWords. Implies PSPDFObjectsTextKey.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsWordsKey

    Swift

    let PSPDFObjectsWordsKey: String
  • Include Text.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextKey

    Swift

    let PSPDFObjectsTextKey: String
  • Include text blocks, sorted after most appropriate.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextBlocksKey

    Swift

    let PSPDFObjectsTextBlocksKey: String
  • Include Image info.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsImagesKey

    Swift

    let PSPDFObjectsImagesKey: String
  • Output category for annotations.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationsKey

    Swift

    let PSPDFObjectsAnnotationsKey: String
  • Ignore too large text blocks (that are > 90% of a page)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsIgnoreLargeTextBlocksKey

    Swift

    let PSPDFObjectsIgnoreLargeTextBlocksKey: String
  • Include annotations of attached type

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationTypesKey

    Swift

    let PSPDFObjectsAnnotationTypesKey: String
  • Special case; used for PSPDFAnnotationTypeNote hit testing.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationPageBoundsKey

    Swift

    let PSPDFObjectsAnnotationPageBoundsKey: String
  • Special case; Used to correctly hit test zoom-invariant annotations.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsPageZoomLevelKey

    Swift

    let PSPDFObjectsPageZoomLevelKey: String
  • Include annotations that are part of a group.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationIncludedGroupedKey

    Swift

    let PSPDFObjectsAnnotationIncludedGroupedKey: String
  • Will sort words/annotations (smaller words/annotations first). Use for touch detection.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsSmartSortKey

    Swift

    let PSPDFObjectsSmartSortKey: String
  • Will use path-based hit-testing based on the center point if set. All annotations that support path based hit-testing but fail the test will be excluded from the results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectMinDiameterKey

    Swift

    let PSPDFObjectMinDiameterKey: String
  • Will look at the text flow and select full sentences, not just what’s within the rect.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextFlowKey

    Swift

    let PSPDFObjectsTextFlowKey: String
  • Will stop after finding the first matching object.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsFindFirstOnlyKey

    Swift

    let PSPDFObjectsFindFirstOnlyKey: String
  • Only relevant for rect. Will test for intersection instead of objects that are fully included in the pdfRect. Defaults to YES if not set.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTestIntersectionKey

    Swift

    let PSPDFObjectsTestIntersectionKey: String
  • The notification posted when a checkpoint is saved. The object sending this is the document’s checkpointer.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDocumentCheckpointSavedNotification

    Swift

    static let PSPDFDocumentCheckpointSaved: NSNotification.Name
  • The key set in PSPDFDocumentCheckpointSavedNotification‘s userInfo that indicates (using a BOOL wrapped in a NSNumber) whether the checkpoint saved successfully or not.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFDocumentCheckpointSavedNotificationSucessKey

    Swift

    let PSPDFDocumentCheckpointSavedNotificationSucessKey: String
  • Fired whenever the toolbar visibility changes.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDocumentEditorToolbarControllerVisibilityDidChangeNotification

    Swift

    static let PSPDFDocumentEditorToolbarControllerVisibilityDidChange: NSNotification.Name
  • Key inside the notification’s userInfo.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFDocumentEditorToolbarControllerVisibilityAnimatedKey

    Swift

    let PSPDFDocumentEditorToolbarControllerVisibilityAnimatedKey: String
  • The constant to be used to indicate that the key length should be determined automatically.

    Declaration

    Objective-C

    extern const NSUInteger PSPDFDocumentSecurityOptionsKeyLengthAutomatic

    Swift

    let PSPDFDocumentSecurityOptionsKeyLengthAutomatic: UInt
  • The XMP PDF namespace.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPPDFNamespace

    Swift

    let PSPDFXMPPDFNamespace: String
  • The XMP PDF namespace prefix.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPPDFNamespacePrefix

    Swift

    let PSPDFXMPPDFNamespacePrefix: String
  • The XMP Dublin Core namespace.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPDCNamespace

    Swift

    let PSPDFXMPDCNamespace: String
  • The XMP Dublin Core namespace prefix.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPDCNamespacePrefix

    Swift

    let PSPDFXMPDCNamespacePrefix: String
  • Posted whenever a task starts loading.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidStartLoadingTaskNotification

    Swift

    static let PSPDFDownloadManagerDidStartLoadingTask: NSNotification.Name
  • Posted whenever a task finishes loading.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidFinishLoadingTaskNotification

    Swift

    static let PSPDFDownloadManagerDidFinishLoadingTask: NSNotification.Name
  • Posted whenever a task failed to load.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidFailToLoadTaskNotification

    Swift

    static let PSPDFDownloadManagerDidFailToLoadTask: NSNotification.Name
  • The PSPDFKit Error Domain.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFErrorDomain

    Swift

    let PSPDFErrorDomain: String
  • The minimum acceptable font to be used when editing fields with autosizing fonts.

    Declaration

    Objective-C

    static const CGFloat PSPDFMinimumAcceptableFontSize = 5.F

    Swift

    let PSPDFMinimumAcceptableFontSize: CGFloat
  • Notification when someone pressed Clear Field.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFFormInputAccessoryViewDidPressClearButtonNotification

    Swift

    static let PSPDFFormInputAccessoryViewDidPressClearButton: NSNotification.Name
  • Notification when someone presses Clear.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFFreeTextAccessoryViewDidPressClearButtonNotification

    Swift

    static let PSPDFFreeTextAccessoryViewDidPressClearButton: NSNotification.Name
  • String. The type of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemTypeKey

    Swift

    let PSPDFGalleryItemTypeKey: String
  • String. The content URL of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemContentURLKey

    Swift

    let PSPDFGalleryItemContentURLKey: String
  • String. The caption of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemCaptionKey

    Swift

    let PSPDFGalleryItemCaptionKey: String
  • String. The options of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemOptionsKey

    Swift

    let PSPDFGalleryItemOptionsKey: String
  • Boolean. Indicates if the content should automatically start playing.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionAutoplay

    Swift

    let PSPDFGalleryOptionAutoplay: String
  • Boolean. Indicates if controls should be displayed.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionControls

    Swift

    let PSPDFGalleryOptionControls: String
  • Boolean. Indicates if the content should loop forever.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionLoop

    Swift

    let PSPDFGalleryOptionLoop: String
  • Boolean. Indicates that the content can be presented fullscreen.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionFullscreen

    Swift

    let PSPDFGalleryOptionFullscreen: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSErrorDomain const PSPDFGalleryManifestErrorDomain

    Swift

    let PSPDFGalleryManifestErrorDomain: String
  • NSString. Indicates the cover mode.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverMode

    Swift

    let PSPDFGalleryOptionCoverMode: String
  • NSURL. Indicates which image should be presented as a cover view.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverImage

    Swift

    let PSPDFGalleryOptionCoverImage: String
  • NSNumber. The time in the video where the preview should be captured.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverPreviewCaptureTime

    Swift

    let PSPDFGalleryOptionCoverPreviewCaptureTime: String
  • NSArray. The preferred video qualities.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionPreferredVideoQualities

    Swift

    let PSPDFGalleryOptionPreferredVideoQualities: String
  • NSNumber. The start time of the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionStartTime

    Swift

    let PSPDFGalleryOptionStartTime: String
  • NSNumber. The end time of the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionEndTime

    Swift

    let PSPDFGalleryOptionEndTime: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT const NSRange PSPDFInvalidGlyphRange

    Swift

    let PSPDFInvalidGlyphRange: NSRange
  • Domain for errors encountered by PSPDFKit Instant.

    Declaration

    Objective-C

    extern const NSErrorDomain _Nonnull PSPDFInstantErrorDomain

    Swift

    let PSPDFInstantErrorDomain: String
  • Key for NSError userInfo for the PSPDFInstantDocumentDescriptorDescriptor an error relates to, if applicable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorDocumentDescriptorKey

    Swift

    let PSPDFInstantErrorDocumentDescriptorKey: String
  • Key for NSError userInfo for the PSPDFDocument an error relates to, if applicable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorDocumentKey

    Swift

    let PSPDFInstantErrorDocumentKey: String
  • Key for NSError userInfo for the annotation identifier an error relates to, if applicable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorAnnotationIdentifierKey

    Swift

    let PSPDFInstantErrorAnnotationIdentifierKey: String
  • User info key for the (extended) SQLite error code as an NSNumber in the case of PSPDFInstantErrorDatabaseAccessFailed.

    A detailed discussions of these codes can be found at https://www.sqlite.org/rescode.html

    Note

    Important: This value can very well be nil! (Not all database access errors need to be SQLite errors.)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorSQLiteExtendedErrorCodeKey

    Swift

    let PSPDFInstantErrorSQLiteExtendedErrorCodeKey: String
  • User info key for the detailed errors in the case of PSPDFInstantErrorCouldNotPurgeDiskCacheEntries.

    The value under this key is an NSDictionary<NSString *, NSError *> *, where each key represents a document ID that could not be purged, and the corresponding value captures the reason why this failed.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorPurgeErrorsByDocumentIDKey

    Swift

    let PSPDFInstantErrorPurgeErrorsByDocumentIDKey: String
  • User info key for the identifier of the attachment in the case of PSPDFInstantErrorAttachmentNotLoaded or PSPDFInstantErrorNoSuchAttachment.

    The value under this key is the identifier for the attachment that could not be accessed/fetched as an NSString.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorAttachmentIDKey

    Swift

    let PSPDFInstantErrorAttachmentIDKey: String
  • The annotation that caused an error.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorAnnotationKey

    Swift

    let PSPDFInstantErrorAnnotationKey: String
  • The library version.

    Declaration

    Objective-C

    extern const NSUInteger PSPDFLibraryVersion

    Swift

    let PSPDFLibraryVersion: UInt
  • PSPDFLibrary uses NSNotifications to post status updates.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryWillStartIndexingDocumentNotification

    Swift

    static let PSPDFLibraryWillStartIndexingDocument: NSNotification.Name
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSNotificationName const PSPDFLibraryDidFinishIndexingDocumentNotification

    Swift

    static let PSPDFLibraryDidFinishIndexingDocument: NSNotification.Name
  • Sent when a document is removed from the library.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidRemoveDocumentNotification

    Swift

    static let PSPDFLibraryDidRemoveDocument: NSNotification.Name
  • Sent when all indexes are cleared as a result of -[PSPDFLibrary clearAllIndexes].

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidClearIndexesNotification

    Swift

    static let PSPDFLibraryDidClearIndexes: NSNotification.Name
  • The key in the NSNotification userInfo for the UID of the document.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationUIDKey

    Swift

    let PSPDFLibraryNotificationUIDKey: String
  • The key in the NSNotification userInfo if the indexing operation was successful.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationSuccessKey

    Swift

    let PSPDFLibraryNotificationSuccessKey: String
  • The name of the exception thrown when an invalid operation occurs.

    Declaration

    Objective-C

    extern const NSExceptionName _Nonnull PSPDFLibraryInvalidOperationException

    Swift

    static let PSPDFLibraryInvalidOperationException: NSExceptionName
  • The name of PSPDFKit’s custom porter tokenizer.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryPorterTokenizerName

    Swift

    let PSPDFLibraryPorterTokenizerName: String
  • The name of PSPDFKit’s custom Unicode tokenizer. This tokenizer wraps around SQLite’s unicode61 tokenizer to add full case folding to the indexed text.

    Warning

    This tokenizer is only available when the library supports FTS5. Specifying this as the value for the PSPDFLibrary.tokenizer property will result in an error when trying to create the library.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryUnicodeTokenizerName

    Swift

    let PSPDFLibraryUnicodeTokenizerName: String
  • Option keys. Limit the number of document results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMaximumSearchResultsTotalKey

    Swift

    let PSPDFLibraryMaximumSearchResultsTotalKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFLibraryMaximumSearchResultsPerDocumentKey

    Swift

    let PSPDFLibraryMaximumSearchResultsPerDocumentKey: String
  • Limit the number of preview results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMaximumPreviewResultsTotalKey

    Swift

    let PSPDFLibraryMaximumPreviewResultsTotalKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFLibraryMaximumPreviewResultsPerDocumentKey

    Swift

    let PSPDFLibraryMaximumPreviewResultsPerDocumentKey: String
  • Set this to @YES to restrict search to exact word matches instead of beginsWith/endsWith checks.

    Warning

    If the default tokenizer is used, this will impact performance. If you find it is too slow, consider using a different tokenizer. See https://pspdfkit.com/guides/ios/current/features/indexed-full-text-search/

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMatchExactWordsOnlyKey

    Swift

    let PSPDFLibraryMatchExactWordsOnlyKey: String
  • Set this to @YES to restrict search to exact phrase matches. This means that Lorem ipsum dolor only matches that phrase and not something like Lorem sit ipsum dolor.

    Warning

    If the default tokenizer is used, this will impact performance. If you find it is too slow, consider using a different tokenizer. See https://pspdfkit.com/guides/ios/current/features/indexed-full-text-search/

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMatchExactPhrasesOnlyKey

    Swift

    let PSPDFLibraryMatchExactPhrasesOnlyKey: String
  • Set this to @YES to exclude annotations from the search. By default, indexed annotations will be searched.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryExcludeAnnotationsKey

    Swift

    let PSPDFLibraryExcludeAnnotationsKey: String
  • Set this to @YES to include document text from the search. By default, indexed document text will be searched.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryExcludeDocumentTextKey

    Swift

    let PSPDFLibraryExcludeDocumentTextKey: String
  • Customizes the range of the preview string. Defaults to 20/160.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryPreviewRangeKey

    Swift

    let PSPDFLibraryPreviewRangeKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT BOOL PSPDFAllowImagesForMenuItems

    Swift

    var PSPDFAllowImagesForMenuItems: ObjCBool
  • Posted whenever any network activity in PSPDFKit starts.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFNetworkActivityDidStartNotification

    Swift

    static let PSPDFNetworkActivityDidStart: NSNotification.Name
  • Posted whenever any network activity in PSPDFKit finishes (that is, either completes or fails).

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFNetworkActivityDidFinishNotification

    Swift

    static let PSPDFNetworkActivityDidFinish: NSNotification.Name
  • Marks an unused or invalid page number.

    Declaration

    Objective-C

    static const PSPDFPageIndex PSPDFPageNull = (9223372036854775807L * 2UL + 1UL)

    Swift

    let PSPDFPageNull: PageIndex
  • Notification is fired when the selectedAnnotations value changed. object is the pageView.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFPageViewSelectedAnnotationsDidChangeNotification

    Swift

    static let PSPDFPageViewSelectedAnnotationsDidChange: NSNotification.Name
  • The name of the notification that is fired when a newly created annotation is inserted.

    Note

    This notification does not have a sender (object == nil).

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationCreateActionDidInsertNotification

    Swift

    static let PSPDFAnnotationCreateActionDidInsert: NSNotification.Name
  • The key, in PSPDFAnnotationCreateActionDidInsertNotification‘s userInfo, that is used to store the array of inserted annotations.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFAnnotationCreateActionInsertedAnnotationsKey

    Swift

    let PSPDFAnnotationCreateActionInsertedAnnotationsKey: String
  • Presentation style.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationStyleKey

    Swift

    let PSPDFPresentationStyleKey: String
  • Set to YES to prevent the presentation from adapting to a different style. This may be used to show popovers in horizontally compact environments. The object stored with this key is expected to be an NSNumber wrapping a Boolean value.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationNonAdaptiveKey

    Swift

    let PSPDFPresentationNonAdaptiveKey: String
  • A block than can be queried to get the current presentation source rectangle, used for popovers and half modal presentations. This is interpreted relative to the source view controller’s view. The type of the block is CGRect (^)(): it doesn’t take any arguments and return a CGRect. This works if the container view resizes, so is preferred over the rectangle in PSPDFPresentationRectKey.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationRectBlockKey

    Swift

    let PSPDFPresentationRectBlockKey: String
  • A convenience for setting the presented view controller’s preferredContentSize just before it is presented.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationContentSizeKey

    Swift

    let PSPDFPresentationContentSizeKey: String
  • Set to YES to embed the controller in a navigation controller. If the controller is already a navigation controller, no change is made. This is automatically inferred if a close button should be added.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationInNavigationControllerKey

    Swift

    let PSPDFPresentationInNavigationControllerKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFPresentationCloseButtonKey

    Swift

    let PSPDFPresentationCloseButtonKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFPresentationPersistentCloseButtonKey

    Swift

    let PSPDFPresentationPersistentCloseButtonKey: String
  • If this is YES and there is an existing presentation in place that also set this to YES, and both presented view controllers are navigation controllers of the same class, then the existing presentation will be reused by setting the viewControllers of the existing navigation controller.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationReuseNavigationControllerKey

    Swift

    let PSPDFPresentationReuseNavigationControllerKey: String
  • Customize default arrow directions for popover.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationPopoverArrowDirectionsKey

    Swift

    let PSPDFPresentationPopoverArrowDirectionsKey: String
  • Customize the popover click-through views. This is required as changing passthroughViews after the controller has been presented has no effect.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationPopoverPassthroughViewsKey

    Swift

    let PSPDFPresentationPopoverPassthroughViewsKey: String
  • Customize the popover backdrop view background color (includes the arrow color).

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationPopoverBackgroundColorKey

    Swift

    let PSPDFPresentationPopoverBackgroundColorKey: String
  • The presentation source rectangle, used for popovers and half modal presentations. This is interpreted relative to the source view controller’s view. PSPDFPresentationRectBlockKey is preferred.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationRectKey

    Swift

    let PSPDFPresentationRectKey: String
  • A block than can be queried to determine if the popover is allowed to be dismissed. Used only for popovers presentations. The type of the block is BOOL (^)(): it doesn’t take any arguments and returns a BOOL. This is called in the presentation managers popoverPresentationControllerShouldDismissPopover:. If this option is not used, and no block is provided, the popover is always dismissable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPresentationShouldPopoverDismissBlockKey

    Swift

    let PSPDFPresentationShouldPopoverDismissBlockKey: String
  • Available keys for options. PSPDFProcessorAnnotationDictKey in form of pageIndex -> annotations. Annotations will be flattened when type is set, unless PSPDFProcessorAnnotationAsDictionaryKey is also set. Don’t forget to also define the types of annotations that should be processed: PSPDFProcessorAnnotationTypesKey: @(PSPDFAnnotationTypeAll).

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorAnnotationTypesKey

    Swift

    let PSPDFProcessorAnnotationTypesKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFProcessorAnnotationDictKey

    Swift

    let PSPDFProcessorAnnotationDictKey: String
  • Set to @YES to add annotations as dictionary and don’t flatten them. Dictionary keys are the original page indexes.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorAnnotationAsDictionaryKey

    Swift

    let PSPDFProcessorAnnotationAsDictionaryKey: String
  • Specifies the user password that should be set on the generated PDF.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorUserPasswordKey

    Swift

    let PSPDFProcessorUserPasswordKey: String
  • Specifies the owner password that should be set on the generated PDF.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorOwnerPasswordKey

    Swift

    let PSPDFProcessorOwnerPasswordKey: String
  • Specifies the key length that should be used to encrypt the PDF. Value must be divisible by 8 and in the range of 40 to 128.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorKeyLengthKey

    Swift

    let PSPDFProcessorKeyLengthKey: String
  • Defaults to PSPDFPaperSizeA4

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorPageRectKey

    Swift

    let PSPDFProcessorPageRectKey: String
  • Defaults to 10. Set lower to optimize, higher if you have a lot of content.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorNumberOfPagesKey

    Swift

    let PSPDFProcessorNumberOfPagesKey: String
  • Defines the page margin. Defaults to UIEdgeInsetsMake(5, 5, 5, 5).

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorPageBorderMarginKey

    Swift

    let PSPDFProcessorPageBorderMarginKey: String
  • If you print web pages, they might load async content which can’t be reliably detected. Defaults to 0.05 seconds. Set higher if you get blank pages.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorAdditionalDelayKey

    Swift

    let PSPDFProcessorAdditionalDelayKey: String
  • Defaults to NO. Adds an additional step to strip white pages if you’re getting any at the end.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorStripEmptyPagesKey

    Swift

    let PSPDFProcessorStripEmptyPagesKey: String
  • Common page sizes. Use for PSPDFProcessorPageRectKey.

    Declaration

    Objective-C

    extern const CGRect PSPDFPaperSizeA4

    Swift

    let PSPDFPaperSizeA4: CGRect
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT const CGRect PSPDFPaperSizeLetter

    Swift

    let PSPDFPaperSizeLetter: CGRect
  • common options Will override any defaults if set.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFProcessorDocumentTitleKey

    Swift

    let PSPDFProcessorDocumentTitleKey: String
  • This notification is triggered if something happens that changes the way a page looks.

    The user info dictionary of this notification always contains the key PSPDFRenderManagerRenderResultChangedDocumentKey which contains the document that changed and optionally PSPDFRenderManagerRenderResultChangedPagesKey which contains an index set of the pages that changed within this document.

    If a document was changed e.g. by adding or removing an annotation, this notification tells you that the render engine and the cache have been updated and scheduling a new render task is guaranteed to return the new state of the document.

    In other words: If you constantly want to show up to date data, observe this notification and request a new image when this notification is posted.

    Note

    This notification is posted on an arbitraty queue. If you need to react on this on the main queue, you need to switch to the main queue yourself.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFRenderManagerRenderResultDidChangeNotification

    Swift

    static let PSPDFRenderManagerRenderResultDidChange: NSNotification.Name
  • The key of a PSPDFRenderManagerRenderResultDidChangeNotification userInfo’s dictionary, containing the PSPDFDocument that was changed.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFRenderManagerRenderResultChangedDocumentKey

    Swift

    let PSPDFRenderManagerRenderResultChangedDocumentKey: String
  • The key of a PSPDFRenderManagerRenderResultDidChangeNotification userInfo’s dictionary, containing an NSIndexSet with all the relevant pages. If the entry for this key in the user info dictionary is nil, the whole document should be treated as changed.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFRenderManagerRenderResultChangedPagesKey

    Swift

    let PSPDFRenderManagerRenderResultChangedPagesKey: String
  • The PSPDFPageInfo object containing page info.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPageRendererPageInfoKey

    Swift

    let PSPDFPageRendererPageInfoKey: String
  • Absolute limit for image rendering (memory constraint)

    Declaration

    Objective-C

    extern const CGSize PSPDFRenderSizeLimit

    Swift

    let PSPDFRenderSizeLimit: CGSize
  • Constant used to always force guide snapping.

    Declaration

    Objective-C

    extern const CGFloat PSPDFGuideSnapAllowanceAlways

    Swift

    let PSPDFGuideSnapAllowanceAlways: CGFloat
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSString *const PSPDFSignerErrorDomain

    Swift

    let PSPDFSignerErrorDomain: String
  • Posted when recording or playback is started, paused or stopped.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFSoundAnnotationChangedStateNotification

    Swift

    static let PSPDFSoundAnnotationChangedState: NSNotification.Name
  • Posted when +stopRecordingOrPlaybackForAllExcept: is invoked.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFSoundAnnotationStopAllNotification

    Swift

    static let PSPDFSoundAnnotationStopAll: NSNotification.Name
  • Language auto-detection.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFSpeechSynthesizerAutoDetectLanguage

    Swift

    let PSPDFSpeechSynthesizerAutoDetectLanguage: String
  • Force a specific language.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFSpeechSynthesizerLanguageKey

    Swift

    let PSPDFSpeechSynthesizerLanguageKey: String
  • Provide text to sample a language.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFSpeechSynthesizerLanguageHintKey

    Swift

    let PSPDFSpeechSynthesizerLanguageHintKey: String
  • A green checkmark stamp. Does not display text. From Adobe Acrobat’s Sign Here stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeAccepted

    Swift

    static let accepted: PSPDFStampType
  • A green stamp that displays the text ‘APPROVED’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeApproved

    Swift

    static let approved: PSPDFStampType
  • A stamp that displays the text ‘AS IS’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeAsIs

    Swift

    static let asIs: PSPDFStampType
  • A green stamp that displays the text ‘COMPLETED’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeCompleted

    Swift

    static let completed: PSPDFStampType
  • A stamp that displays the text ‘CONFIDENTIAL’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeConfidential

    Swift

    static let confidential: PSPDFStampType
  • A stamp that displays the text ‘DEPARTMENTAL’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeDepartmental

    Swift

    static let departmental: PSPDFStampType
  • A stamp that displays the text ‘DRAFT’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeDraft

    Swift

    static let draft: PSPDFStampType
  • A stamp that displays the text ‘EXPERIMENTAL’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeExperimental

    Swift

    static let experimental: PSPDFStampType
  • A stamp that displays the text ‘EXPIRED’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeExpired

    Swift

    static let expired: PSPDFStampType
  • A green stamp that displays the text ‘FINAL’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeFinal

    Swift

    static let final: PSPDFStampType
  • A stamp that displays the text ‘FOR COMMENT’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeForComment

    Swift

    static let forComment: PSPDFStampType
  • A stamp that displays the text ‘FOR PUBLIC RELEASE’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeForPublicRelease

    Swift

    static let forPublicRelease: PSPDFStampType
  • A stamp that displays the text ‘INFORMATION ONLY’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeInformationOnly

    Swift

    static let informationOnly: PSPDFStampType
  • A stamp with a left-pointing arrow that displays the text ‘INITIAL HERE’ in English. From Adobe Acrobat’s Sign Here stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeInitialHere

    Swift

    static let initialHere: PSPDFStampType
  • A red stamp that displays the text ‘NOT APPROVED’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeNotApproved

    Swift

    static let notApproved: PSPDFStampType
  • A stamp that displays the text ‘NOT FOR PUBLIC RELEASE’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeNotForPublicRelease

    Swift

    static let notForPublicRelease: PSPDFStampType
  • A stamp that displays the text ‘PRELIMINARY RESULTS’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypePreliminaryResults

    Swift

    static let preliminaryResults: PSPDFStampType
  • A red cross stamp. Does not display text. From Adobe Acrobat’s Sign Here stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeRejected

    Swift

    static let rejected: PSPDFStampType
  • A stamp that displays the text ‘REVISED’ in English. From Adobe Acrobat’s Dynamic stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeRevised

    Swift

    static let revised: PSPDFStampType
  • A red stamp with a left-pointing arrow that displays the text ‘SIGN HERE’ in English. From Adobe Acrobat’s Sign Here stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeSignHere

    Swift

    static let signHere: PSPDFStampType
  • A stamp that displays the text ‘SOLD’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeSold

    Swift

    static let sold: PSPDFStampType
  • A stamp that displays the text ‘TOP SECRET’ in English. From the PDF specification.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeTopSecret

    Swift

    static let topSecret: PSPDFStampType
  • A red stamp that displays the text ‘VOID’ in English. From Adobe Acrobat’s Standard Business stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeVoid

    Swift

    static let void: PSPDFStampType
  • A yellow stamp with a left-pointing arrow that displays the text ‘WITNESS’ in English. From Adobe Acrobat’s Sign Here stamps.

    Declaration

    Objective-C

    extern const PSPDFStampType _Nonnull PSPDFStampTypeWitness

    Swift

    static let witness: PSPDFStampType
  • Show the overflow button only when the number of tabs and minimum tab width result in the tabbed bar scrolling.

    Declaration

    Objective-C

    static const NSInteger PSPDFTabbedBarOverflowThresholdAutomatic = -1

    Swift

    let PSPDFTabbedBarOverflowThresholdAutomatic: Int
  • Never show the overflow button.

    Declaration

    Objective-C

    static const NSInteger PSPDFTabbedBarOverflowThresholdNever =
        9223372036854775807L

    Swift

    let PSPDFTabbedBarOverflowThresholdNever: Int
  • Mask for all text markups. PSPDFAnnotationTypeHighlight|PSPDFAnnotationTypeStrikeOut|PSPDFAnnotationTypeUnderline|PSPDFAnnotationTypeSquiggly

    Declaration

    Objective-C

    extern const PSPDFAnnotationType PSPDFAnnotationTypeTextMarkup

    Swift

    let PSPDFAnnotationTypeTextMarkup: AnnotationType
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT const CGFloat PSPDFToolbarDefaultFixedDimensionLength

    Swift

    let PSPDFToolbarDefaultFixedDimensionLength: CGFloat
  • Sent once we have new undo operations available.

    Note

    Always sent on the main thread.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFUndoControllerAddedUndoActionNotification

    Swift

    static let PSPDFUndoControllerAddedUndoAction: NSNotification.Name
  • Sent once we have available undo actions have been changed/removed.

    Note

    Always sent on the main thread.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFUndoControllerRemovedUndoActionNotification

    Swift

    static let PSPDFUndoControllerRemovedUndoAction: NSNotification.Name
  • Can be used to reset the first responder after the username flow is complete.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFUsernameHelperWillDismissAlertNotification

    Swift

    static let PSPDFUsernameHelperWillDismissAlert: NSNotification.Name
  • Search current page, but don’t show any search UI. Dictionary key, expects a boxed boolean as value.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFViewControllerSearchHeadlessKey

    Swift

    let PSPDFViewControllerSearchHeadlessKey: String
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSNotificationName const PSPDFWebViewControllerDidStartLoadingNotification

    Swift

    static let PSPDFWebViewControllerDidStartLoading: NSNotification.Name
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSNotificationName const PSPDFWebViewControllerDidFinishLoadingNotification

    Swift

    static let PSPDFWebViewControllerDidFinishLoading: NSNotification.Name
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSNotificationName const PSPDFWebViewControllerDidFailToLoadNotification

    Swift

    static let PSPDFWebViewControllerDidFailToLoad: NSNotification.Name