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
  • 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
  • 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
  • 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
  • Only relevant if PSPDFObjectsTestIntersectionKey is set to YES. Test succeeds if the fraction of the overlapping area between the object and pdfRect is greater than the fraction set here. Defaults to 0 if not set, which means the test succeeds if there is any intersection at all. Valid values: 0 - 1.

    @note: The overlap is calculated w.r.t the total area. So, if ao is the area of the object, ap is the area of pdfRect and ai is the intersecting area, then the overlap proportion would be ai / (ao + ap - ai).

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTestIntersectionFractionKey

    Swift

    let PSPDFObjectsTestIntersectionFractionKey: 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
  • 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
  • Undocumented

    Declaration

    Objective-C

    PSPDF_EXPORT NSNotificationName const PSPDFApplicationDidReceiveMemoryWarningNotification

    Swift

    static let PSPDFApplicationDidReceiveMemoryWarning: 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.

    Swift

    let PSPDFMinimumAcceptableFontSize: CGFloat
  • An NSRange representing an invalid range of PSPDFGlyphs.

    Declaration

    Objective-C

    extern const NSRange PSPDFInvalidGlyphRange

    Swift

    let PSPDFInvalidGlyphRange: NSRange
  • 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
  • Marks an unused or invalid page number.

    Declaration

    Objective-C

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

    Swift

    let PSPDFPageNull: PageIndex
  • 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 arbitrary 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
  • 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
  • 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
  • Mask for all text markups. PSPDFAnnotationTypeHighlight|PSPDFAnnotationTypeStrikeOut|PSPDFAnnotationTypeUnderline|PSPDFAnnotationTypeSquiggly

    Declaration

    Objective-C

    extern const PSPDFAnnotationType PSPDFAnnotationTypeTextMarkup

    Swift

    let PSPDFAnnotationTypeTextMarkup: AnnotationType
  • 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