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
class let defaultNumberOfPBKDFRounds: 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 const PSPDFActionOption _Nonnull PSPDFActionOptionModalKey
Swift
static let modalKey: Action.Option
-
Enable Autoplay if target is a video.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionAutoplayKey
Swift
static let autoplayKey: Action.Option
-
Enable/Disable controls. (e.g. Browser back/next buttons)
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionControlsKey
Swift
static let controlsKey: Action.Option
-
Loop the video.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionLoopKey
Swift
static let loopKey: Action.Option
-
Allow fullscreen presentation.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionFullscreenKey
Swift
static let fullscreenKey: Action.Option
-
Set video offset.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionOffsetKey
Swift
static let offsetKey: Action.Option
-
Set modal size.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionSizeKey
Swift
static let sizeKey: Action.Option
-
Show as popover.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionPopoverKey
Swift
static let popoverKey: Action.Option
-
Show cover, accepts string path.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionCoverKey
Swift
static let coverKey: Action.Option
-
The target page.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionPageKey
Swift
static let pageKey: Action.Option
-
Shows a button that activates links.
Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionButtonKey
Swift
static let buttonKey: Action.Option
-
Controls if a close button is displayed, when
PSPDFActionOptionButtonKey
is used. Default will be YES.Declaration
Objective-C
extern const PSPDFActionOption _Nonnull PSPDFActionOptionCloseButtonKey
Swift
static let closeButtonKey: Action.Option
-
Constant to convert
PSPDFActionType
intoNSString
and back.Note
The transformer is added in the class initialize phase. RequiresPSPDFAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(actionType) const NSValueTransformerName PSPDFActionTypeTransformerName
Swift
static let actionType: NSValueTransformerName
-
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
-
Document load event. This event signifies that the user has loaded a document.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameDocumentType
. Value:PSPDFAnalyticsEventAttributeValueDocumentTypeImage
forPSPDFImageDocument
,PSPDFAnalyticsEventAttributeValueDocumentTypeStandard
for other documents.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameDocumentLoad
Swift
static let documentLoad: PDFAnalytics.EventName
- Key:
-
Spread change event. This signifies that the spread was changed.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeValuePreviousSpreadIndex
. Value: integer spread index before the spread change. - Key:
PSPDFAnalyticsEventAttributeValueNewSpreadIndex
. Value: integer spread index after the spread change.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameSpreadChange
Swift
static let spreadChange: PDFAnalytics.EventName
- Key:
-
Enter annotation creation mode event. This event signifies that the user opened the annotation toolbar. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreationModeEnter
Swift
static let annotationCreationModeEnter: PDFAnalytics.EventName
-
Exit annotation creation mode event. This event signifies that the user closed the annotation toolbar. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreationModeExit
Swift
static let annotationCreationModeExit: PDFAnalytics.EventName
-
Show annotation creator dialog event. This signifies that the annotation creator dialog was shown to the user. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreatorDialogShow
Swift
static let annotationCreatorDialogShow: PDFAnalytics.EventName
-
Cancel annotation creator dialog event. Signifies that the annotation creator dialog was cancelled by the user. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreatorDialogCancel
Swift
static let annotationCreatorDialogCancel: PDFAnalytics.EventName
-
Set annotation creator event. Signifies that the annotation creator dialog was confirmed by the user, setting a creator name. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreatorSet
Swift
static let annotationCreatorSet: PDFAnalytics.EventName
-
Select annotation event. This signifies that the user selected an annotation, either by tapping it or by any other option (for example using the annotation list).
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameAnnotationType
. Value:PSPDFAnnotationString
of the selected annotation.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationSelect
Swift
static let annotationSelect: PDFAnalytics.EventName
- Key:
-
Create annotation event. This signifies that the user created an annotation and added it to the document.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameAnnotationType
. Value:PSPDFAnnotationString
of the created annotation.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationCreate
Swift
static let annotationCreate: PDFAnalytics.EventName
- Key:
-
Delete annotation event. This signifies that the user deleted an annotation from the document.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameAnnotationType
. Value:PSPDFAnnotationString
of the deleted annotation.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationDelete
Swift
static let annotationDelete: PDFAnalytics.EventName
- Key:
-
Show annotation inspector event. This signifies that the user has opened the annotation inspector for editing annotation properties, either via the annotation toolbar or by editing an existing annotation. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameAnnotationInspectorShow
Swift
static let annotationInspectorShow: PDFAnalytics.EventName
-
Select text event. This signifies that the user has selected text on the document. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameTextSelect
Swift
static let textSelect: PDFAnalytics.EventName
-
Open outline event. This signifies that the user opened the outline containing the document outline, annotations, and bookmarks. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameOutlineOpen
Swift
static let outlineOpen: PDFAnalytics.EventName
-
Tap outline element in outline view event. This signifies that the user tapped an outline element in the outline view. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameOutlineElementSelect
Swift
static let outlineElementSelect: PDFAnalytics.EventName
-
Tap annotation in outline view event. This signifies that the user tapped an annotation in the outline view.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameAnnotationType
. Value:PSPDFAnnotationString
of the selected annotation.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameOutlineAnnotationSelect
Swift
static let outlineAnnotationSelect: PDFAnalytics.EventName
- Key:
-
Open thumbnail grid event. This signifies that the user opened the thumbnail grid view. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameThumbnailGridOpen
Swift
static let thumbnailGridOpen: PDFAnalytics.EventName
-
Open document editor event. This signifies that the user opened the document editor. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameDocumentEditorOpen
Swift
static let documentEditorOpen: PDFAnalytics.EventName
-
Perform document editor action event. This signifies that the user performed an action inside the document editor.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameAction
. Value:PSPDFAnalyticsEventAttributeValueAction
the user performed in the document editor (likePSPDFAnalyticsEventAttributeValueActionInsertNewPage
)
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameDocumentEditorAction
Swift
static let documentEditorAction: PDFAnalytics.EventName
- Key:
-
Add bookmark event. This signifies that the user added a bookmark to the document. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkAdd
Swift
static let bookmarkAdd: PDFAnalytics.EventName
-
Edit bookmarks event. This signifies that the user has entered bookmark editing mode inside the bookmark list. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkEdit
Swift
static let bookmarkEdit: PDFAnalytics.EventName
-
Delete bookmark event. This signifies that the user has deleted a bookmark from the document. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkRemove
Swift
static let bookmarkRemove: PDFAnalytics.EventName
-
Sort bookmark event. This signifies that the user changed moved the order of a bookmark item in the bookmark list. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkSort
Swift
static let bookmarkSort: PDFAnalytics.EventName
-
Rename bookmark event. This signifies that the user renamed a bookmark. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkRename
Swift
static let bookmarkRename: PDFAnalytics.EventName
-
Select bookmark event. This signifies that the user tapped a bookmark in the bookmark list. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameBookmarkSelect
Swift
static let bookmarkSelect: PDFAnalytics.EventName
-
Start search event. This signifies that the user started a search in the document by pressing the search icon (or any other way). No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameSearchStart
Swift
static let searchStart: PDFAnalytics.EventName
-
Search result select event. This signifies that the user selected a search result after searching the document. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameSearchResultSelect
Swift
static let searchResultSelect: PDFAnalytics.EventName
-
Share event. This signifies that the user has shared the document using the share sheet.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeNameActivityType
. Value: Activity type the user selected as string.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameShare
Swift
static let share: PDFAnalytics.EventName
- Key:
-
Move toolbar event. This signifies that the toolbar was moved to a different location.
Attributes:
- Key:
PSPDFAnalyticsEventAttributeValueToolbarPosition
. Value:PSPDFFlexibleToolbarPosition
of the destination.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameToolbarMove
Swift
static let toolbarMove: PDFAnalytics.EventName
- Key:
-
Reader View was shown. No attributes.
Declaration
Objective-C
extern const PSPDFAnalyticsEventName PSPDFAnalyticsEventNameReaderViewOpen
Swift
static let readerViewOpen: PDFAnalytics.EventName
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeName const PSPDFAnalyticsEventAttributeNameDocumentType
Swift
static let documentType: PDFAnalytics.EventAttributeName
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeName const PSPDFAnalyticsEventAttributeNameAnnotationType
Swift
static let annotationType: PDFAnalytics.EventAttributeName
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeName const PSPDFAnalyticsEventAttributeNameAction
Swift
static let action: PDFAnalytics.EventAttributeName
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeName const PSPDFAnalyticsEventAttributeNameActivityType
Swift
static let activityType: PDFAnalytics.EventAttributeName
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueDocumentTypeStandard
Swift
static let documentTypeStandard: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueDocumentTypeImage
Swift
static let documentTypeImage: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionInsertNewPage
Swift
static let actionInsertNewPage: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionRemoveSelectedPages
Swift
static let actionRemoveSelectedPages: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionDuplicateSelectedPages
Swift
static let actionDuplicateSelectedPages: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionRotateSelectedPages
Swift
static let actionRotateSelectedPages: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionExportSelectedPages
Swift
static let actionExportSelectedPages: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionSelectAllPages
Swift
static let actionSelectAllPages: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionUndo
Swift
static let actionUndo: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueActionRedo
Swift
static let actionRedo: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueToolbarPosition
Swift
static let toolbarPosition: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValuePreviousSpreadIndex
Swift
static let previousSpreadIndex: PDFAnalytics.EventAttributeValue
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFAnalyticsEventAttributeValue const PSPDFAnalyticsEventAttributeValueNewSpreadIndex
Swift
static let newSpreadIndex: PDFAnalytics.EventAttributeValue
-
Tool for adding links.
This annotation type also includes PSPDFKit multimedia extensions.
See
This tool createsPSPDFLinkAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringLink
Swift
static let link: Annotation.Tool
-
Tool for highlighting text.
See
This tool createsPSPDFHighlightAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringHighlight
Swift
static let highlight: Annotation.Tool
-
Tool for striking through text.
See
This tool createsPSPDFStrikeOutAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringStrikeOut
Swift
static let strikeOut: Annotation.Tool
-
Tool for underlining text.
See
This tool createsPSPDFUnderlineAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringUnderline
Swift
static let underline: Annotation.Tool
-
Tool for underlining text with a squiggly line.
See
This tool createsPSPDFSquigglyAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSquiggly
Swift
static let squiggly: Annotation.Tool
-
Tool for adding a note (AKA a comment) to a document.
This shows an icon on the page and the full text of the comment (including any replies) are shown in a popup when tapping the icon.
See
This tool createsPSPDFNoteAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringNote
Swift
static let note: Annotation.Tool
-
Tool for adding text annotations.
Text annotations show their text overlaid over the page itself rather than in a popup (as note annotations do).
Callout annotations are a variant of text annotations (
PSPDFAnnotationVariantStringFreeTextCallout
).See
This tool createsFreeTextAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringFreeText
Swift
static let freeText: Annotation.Tool
-
Tool for freehand drawing, writing or highlighting.
Ink signatures created using
Annotation.Tool.signature
will have this regular ink type after creation. You can check if an ink annotation is a signature using theisSignature
property, which is a proprietary PSPDFKit extension stored in the PDF.See
This tool createsPSPDFInkAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringInk
Swift
static let ink: Annotation.Tool
-
Tool for adding rectangles.
See
This tool createsPSPDFSquareAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSquare
Swift
static let square: Annotation.Tool
-
Tool for adding ellipses.
See
This tool createsPSPDFCircleAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringCircle
Swift
static let circle: Annotation.Tool
-
Tool for adding lines or arrows.
See
This tool createsPSPDFLineAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringLine
Swift
static let line: Annotation.Tool
-
Tool for adding polygons (closed shapes).
See
This tool createsPSPDFPolygonAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPolygon
Swift
static let polygon: Annotation.Tool
-
Tool for adding joined straight lines (open shapes).
See
This tool createsPSPDFPolyLineAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPolyLine
Swift
static let polyLine: Annotation.Tool
-
Tool for adding electronic signatures.
Signatures end up as either drawings (
InkAnnotation
/Annotation.Tool.ink
) or image annotations (StampAnnotation
/Annotation.Tool.stamp
). You can check if an annotation is a signature using theisSignature
property, which is a proprietary PSPDFKit extension stored in the PDF.Check out https://pspdfkit.com/guides/ios/signatures/overview/ for more general information about signatures.
This requires Electronic Signatures to be enabled in your license. (This tool is also available for licenses with Annotations obtained in April 2021 or earlier. In that case, it will offer a more limited signing UI that only supports drawing.)
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSignature
Swift
static let signature: Annotation.Tool
-
Tool for adding stamps.
Images added using
PSPDFAnnotationStringImage
will end up with this type.Stamps display text or certain predefined vector images.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringStamp
Swift
static let stamp: Annotation.Tool
-
Special tool for erasing parts of drawings (ink annotations).
There is no corresponding annotation type.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringEraser
Swift
static let eraser: Annotation.Tool
-
Tool for adding sound annotations.
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.See
This tool createsPSPDFSoundAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSound
Swift
static let sound: Annotation.Tool
-
Tool for adding images.
After being added to a document, an image will have the
typeString
PSPDFAnnotationStringStamp
.UIImagePickerController
will be used to pick an image. This will throw aUIApplicationInvalidInterfaceOrientation
exception if your app does not include portrait inUISupportedInterfaceOrientations
(Info.plist). For landscape only apps, we suggest enabling portrait orientation(s) in your Info.plist and rejecting these inUIViewController
’s auto-rotation methods. This way, you can be landscape only for your view controllers and still be able to useUIImagePickerController
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringImage
Swift
static let image: Annotation.Tool
-
Tool for adding redaction annotations.
See
This tool createsPSPDFRedactionAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringRedaction
Swift
static let redaction: Annotation.Tool
-
A type for widget annotations, which are used for PDF forms.
This is a non-writable annotation type. There is no tool for creating form elements. Instead presence or absence of this value in the
editableAnnotationTypes
of the configuration ofPDFViewController
determines whether users can interact with PDF form elements, which edits the values of the form fields, but does not change the form elements themselves.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringWidget
Swift
static let widget: Annotation.Tool
-
File attachment.
This is a non-writable annotation type. There is no tool for creating file attachments.
See
The corresponding annotation type isPSPDFFileAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringFile
Swift
static let file: Annotation.Tool
-
Embedded PDF video.
This is a non-writable annotation type. There is no tool for creating embedded media.
See
The corresponding annotation type isPSPDFRichMediaAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringRichMedia
Swift
static let richMedia: Annotation.Tool
-
Embedded PDF video.
This is a non-writable annotation type. There is no tool for creating screen annotations.
See
The corresponding annotation type isPSPDFScreenAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringScreen
Swift
static let screen: Annotation.Tool
-
Caret annotation.
This is a non-writable annotation type. There is no tool for creating caret annotations.
See
The corresponding annotation type isPSPDFCaretAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringCaret
Swift
static let caret: Annotation.Tool
-
Popup annotation. Placeholder. Not yet supported.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringPopup
Swift
static let popup: Annotation.Tool
-
Watermark annotation. Placeholder. Not yet supported.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringWatermark
Swift
static let watermark: Annotation.Tool
-
TrapNet annotation. Placeholder. Not yet supported.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringTrapNet
Swift
static let trapNet: Annotation.Tool
-
3D annotation. Placeholder. Not yet supported.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationString3D
Swift
static let string3D: Annotation.Tool
-
NSValueTransformer
to convert betweenPSPDFAnnotationBorderStyle
enum and string value.Note
The transformer is added in the class initialize phase. RequiresPSPDFAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(borderStyle) const NSValueTransformerName PSPDFBorderStyleTransformerName
Swift
static let borderStyle: NSValueTransformerName
-
NSValueTransformer
to convert betweenPSPDFAnnotationBorderEffect
enum and string value.Note
The transformer is added in the class initialize phase. RequiresPSPDFAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(borderEffect) const NSValueTransformerName PSPDFBorderEffectTransformerName
Swift
static let borderEffect: NSValueTransformerName
-
NSValueTransformer
to convert betweenPSPDFAnnotation.TriggerEvent
enum and string value.Note
The transformer is added in the class initialize phase. RequiresPSPDFAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(annotationTriggerEvent) const NSValueTransformerName PSPDFAnnotationTriggerEventTransformerName
Swift
static let annotationTriggerEvent: NSValueTransformerName
-
Default value for non-fixed-sized annotations
Declaration
Objective-C
extern const CGSize PSPDFAnnotationFixedSizeDisabled
Swift
class let fixedSizeDisabled: CGSize
-
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 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 thefontAttributes
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
intoNSString
and back.Note
The transformer is added in the class initialize phase. RequiresPSPDFAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(verticalAlignment) const NSValueTransformerName PSPDFVerticalAlignmentTransformerName
Swift
static let verticalAlignment: NSValueTransformerName
-
Pen Ink annotation, with preset styles for pen for drawing.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringInkPen
Swift
static let inkPen: Annotation.Variant
-
Highlighter Ink annotation, with customized presets for improved text highlighting.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringInkHighlighter
Swift
static let inkHighlighter: Annotation.Variant
-
The Magic Ink tool variant converts the drawn points to a vector shape if possible.
Magic Ink supports detecting straight lines and arrows (
PSPDFLineAnnotation
), ellipses (PSPDFCircleAnnotation
), and rectangles (PSPDFSquareAnnotation
). If no shape is matched, the drawing will be left as aPSPDFInkAnnotation
.The recognition tolerance can be set with the
magicInkReplacementThreshold
property ofPDFConfiguration
.Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringInkMagic
Swift
static let inkMagic: Annotation.Variant
-
Line annotation variant with an arrow at one end of the line.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringLineArrow
Swift
static let lineArrow: Annotation.Variant
-
Text annotation variant that defaults to creating callout text annotations.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringFreeTextCallout
Swift
static let freeTextCallout: Annotation.Variant
-
Cloudy polygon annotation, with cloudy border preset style.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringPolygonCloud
Swift
static let polygonCloud: Annotation.Variant
-
Line annotation variant with distance measurement label.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringDistanceMeasurement
Swift
static let distanceMeasurement: Annotation.Variant
-
Polyline annotation variant with perimeter measurement label.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringPerimeterMeasurement
Swift
static let perimeterMeasurement: Annotation.Variant
-
Polygon annotation variant with area measurement label.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringPolygonalAreaMeasurement
Swift
static let polygonalAreaMeasurement: Annotation.Variant
-
Circle annotation variant with area measurement label.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringEllipticalAreaMeasurement
Swift
static let ellipticalAreaMeasurement: Annotation.Variant
-
Square annotation variant with area measurement label.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringRectangularAreaMeasurement
Swift
static let rectangularAreaMeasurement: Annotation.Variant
-
Line annotation variant for scale calibration measurement.
Declaration
Objective-C
extern const PSPDFAnnotationVariantString _Nonnull PSPDFAnnotationVariantStringMeasurementScaleCalibration
Swift
static let measurementScaleCalibration: Annotation.Variant
-
Notification posted on the main thread when new annotations are added to the default
PSPDFContainerAnnotationProvider
. The notification object is anNSArray
containing the newPSPDFAnnotation
s.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
PSPDFContainerAnnotationProvider
. The notification object is anNSArray
containing the removedPSPDFAnnotation
s.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFAnnotationsRemovedNotification
Swift
static let PSPDFAnnotationsRemoved: NSNotification.Name
-
A notification that should be posted after an annotation’s properties have been changed so that PSPDFKit can re-render the annotation and update the UI.
If you change multiple properties on a single annotation at once then you can post this notification just once after all changes have been made.
PSPDFKit also posts this when it internally makes changes to an annotation.
Warning
Only post this from the main thread!
Warning
Don’t save the document during an observation callback for this notification.
The notification’s object property should be the
Annotation
instance that changed.The notification’s
userInfo
may optionally contain the properties that were changed under the keyPSPDFAnnotationChangedNotificationKeyPathKey
.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
-
Key into the
userInfo
of a.PSPDFAnnotationChanged
notification. Used to store the changed properties.There should be an array of property names as strings stored under this key, which represent the properties that were changed. The order of the elements in the array has no significance. If no entry is stored under this key then please assume that any properties might have changed.
For example, if the
points
andboundingBox
properties were both changed, then theuserInfo
might be like this:[PSPDFAnnotationChangedNotificationKeyPathKey: ["boundingBox", "points"]]
Note
Boolean properties will be prefixed with ‘is’. For example, thedeleted
property becomesisDeleted
.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 PSPDFAnnotationOptionAnimateView
-
Prevents the insertion or removal notifications from being sent (use a BOOL NSNumber value).
Warning
Disabling this option will lead to PSPDFKit not updating its state and views when adding new annotations, which can lead to issues presenting those annotations. Therefore, we don’t recommend using this unless for cases where aPSPDFAnnotationsAdded
notification is sent manually for timing reasons.Declaration
Objective-C
extern const PSPDFAnnotationOption _Nonnull PSPDFAnnotationOptionSuppressNotifications
-
Special type that will add a selection tool to the toolbar.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSelectionTool
Swift
static let selectionTool: Annotation.Tool
-
Special type that will show a view controller with saved/pre-created annotations.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringSavedAnnotations
Swift
static let savedAnnotations: Annotation.Tool
-
Style key representing the annotation
color
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyColor
-
Style key representing the annotation
fillColor
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyFillColor
-
Style key representing the annotation
alpha
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyAlpha
-
Style key representing the annotation
lineWidth
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyLineWidth
-
Style key representing the annotation
dashArray
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyDashArray
-
Style key representing the free text annotation
lineEnd
property.Note
Applicable only toFreeTextAnnotation
in callout mode.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyLineEnd
-
Style key representing the abstract line annotation
lineEnd1
property.Note
Applicable only toPSPDFAbstractLineAnnotation
subclasses.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyLineEnd1
-
Style key representing the abstract line annotation
lineEnd2
property.Note
Applicable only toPSPDFAbstractLineAnnotation
subclasses.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyLineEnd2
-
Style key representing the annotation
fontName
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyFontName
-
Style key representing the annotation
fontSize
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyFontSize
-
Style key representing the annotation
textAlignment
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyTextAlignment
-
Style key representing the annotation
blendMode
property.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyBlendMode
-
Style key representing the redaction annotation
outlineColor
property.Note
Applicable only toPSPDFRedactionAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyOutlineColor
-
Style key representing the redaction annotation
overlayText
property.Note
Applicable only toPSPDFRedactionAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyOverlayText
-
Style key representing the redaction annotation
repeatOverlayText
property.Note
Applicable only toPSPDFRedactionAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyRepeatOverlayText
-
Style key representing the global
measurementSnapping
property, to toggle measurement annotation point snapping.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyMeasurementSnapping
-
Style key representing the annotations
contents
property.This will be displayed in
AnnotationStyleViewController
as a single line of static text. This is only intended to be used for measurement annotations. In other cases, useNoteAnnotationViewController
to view and edit annotationcontents
.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyContents
-
Style key representing the measurement properties of an annotation encapsulated in
MeasurementValueConfiguration
.This option allows to modify a measurement annotation’s
measurementInfo
. Options will be displayed in a new UI which will be presented within theAnnotationStyleViewController
upon tapping the currently selected scale.Note
TheaffectedProperties
in theAnnotationStyleViewControllerDelegate
API will include this key whenmeasurementInfo
has been modified.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyMeasurementValueConfiguration
-
Converting a regular free text annotation into a callout (and vice versa) modifies multiple properties, so we use a special key for the change.
Note
Applicable only toFreeTextAnnotation
.Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyCalloutAction
-
Applying a color preset modifies multiple properties, so we use a special key for the change.
Declaration
Objective-C
extern const PSPDFAnnotationStyleKey _Nonnull PSPDFAnnotationStyleKeyColorPreset
-
This key will return the last used style.
Declaration
Objective-C
extern const PSPDFAnnotationStyleType _Nonnull PSPDFAnnotationStyleTypeLastUsed
Swift
static let lastUsed: AnnotationStyle.Kind
-
This key will mark styles as generic, thus they’ll be returned with all other style types except the last used trait.
Declaration
Objective-C
extern const PSPDFAnnotationStyleType _Nonnull PSPDFAnnotationStyleTypeGeneric
Swift
static let generic: AnnotationStyle.Kind
-
Color preset type
Declaration
Objective-C
extern const PSPDFAnnotationStyleType _Nonnull PSPDFAnnotationStyleTypeColorPreset
Swift
static let colorPreset: AnnotationStyle.Kind
-
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
-
Option for
dataProviderForAnnotation:options:
. If set, the resulting appearance stream is to be used for a flattened document.Declaration
Objective-C
extern const PSPDFAppearanceStreamGenerationOption _Nonnull PSPDFAppearanceGenerationFlatten
Swift
static let generationFlatten: AppearanceStreamGenerationOption
-
Option for
dataProviderForAnnotation:options:
. If set, the resulting appearance stream is to be used for printing.Declaration
Objective-C
extern const PSPDFAppearanceStreamGenerationOption _Nonnull PSPDFAppearanceGenerationPrint
Swift
static let generationPrint: AppearanceStreamGenerationOption
-
Notification posted on the main thread whenever
detected
is set totrue
even if it wastrue
before.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFApplePencilDetectedNotification
Swift
static let PSPDFApplePencilDetected: NSNotification.Name
-
Notification posted on the main thread whenever
enabled
is updated.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFApplePencilEnabledChangedNotification
Swift
static let PSPDFApplePencilEnabledChanged: NSNotification.Name
-
Policy for Open In.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventOpenIn
Swift
static let openIn: PolicyEvent
-
Policy for print.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventPrint
Swift
static let print: PolicyEvent
-
Policy for mail.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventEmail
Swift
static let email: PolicyEvent
-
Policy for message.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventMessage
Swift
static let message: PolicyEvent
-
Policy for Quick Look.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventQuickLook
Swift
static let quickLook: PolicyEvent
-
Policy for audio recording.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventAudioRecording
Swift
static let audioRecording: PolicyEvent
-
Policy for the camera.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventCamera
Swift
static let camera: PolicyEvent
-
Policy for the photo library.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventPhotoLibrary
Swift
static let photoLibrary: PolicyEvent
-
Policy for the pasteboard. Includes Copy/Paste.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventPasteboard
Swift
static let pasteboard: PolicyEvent
-
Policy for submitting forms.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventSubmitForm
Swift
static let submitForm: PolicyEvent
-
Policy for the network.
Declaration
Objective-C
extern const PSPDFPolicyEvent _Nonnull PSPDFPolicyEventNetwork
Swift
static let network: PolicyEvent
-
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
-
Deprecated
Deprecated in PSPDFKit 11.5 for iOS. This has been unused since PSPDFKit 9.3 for iOS because
UIActivityViewController
now includes “open in” functionality directly.This has been unused since PSPDFKit 9.3 for iOS because
UIActivityViewController
now includes “open in” functionality directly.Declaration
Objective-C
extern PSPDF_DEPRECATED( 11.5, "This has been unused since PSPDFKit 9.3 for iOS because " "`UIActivityViewController` now includes “open in” functionality directly.") const UIActivityType PSPDFActivityTypeOpenIn
Swift
static let PSPDFActivityTypeOpenIn: UIActivity.ActivityType
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSString *const PSPDFCryptorErrorDomain
Swift
let PSPDFCryptorErrorDomain: String
-
Option indicating if glyphs should be extracted. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractGlyphs
Swift
static let extractGlyphs: Document.ObjectFinderOption
-
Option indicating if full
PSPDFWord
s should be extracted. ImpliesPSPDFObjectFinderOptionExtractText
. (Type: Boolean wrapped inNSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractWords
Swift
static let extractWords: Document.ObjectFinderOption
-
Option indicating if text should be extracted. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractText
Swift
static let extractText: Document.ObjectFinderOption
-
Option indicating if text blocks should be extracted. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractTextBlocks
Swift
static let extractTextBlocks: Document.ObjectFinderOption
-
Option indicating if image info should be extracted. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractImages
Swift
static let extractImages: Document.ObjectFinderOption
-
Option indicating if annotations should be extracted. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionExtractAnnotations
Swift
static let extractAnnotations: Document.ObjectFinderOption
-
Ignore large text blocks that are > 90% of a page. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionIgnoreLargeTextBlocks
Swift
static let ignoreLargeTextBlocks: Document.ObjectFinderOption
-
Include annotations of attached type. (Type:
PSPDFAnnotationType
wrapped inNSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionAnnotationTypes
Swift
static let annotationTypes: Document.ObjectFinderOption
-
Special case; used for
PSPDFAnnotationTypeNote
hit testing. (Type:CGRect
wrapped inNSValue
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionAnnotationPageBounds
Swift
static let annotationPageBounds: Document.ObjectFinderOption
-
Special case; Used to correctly hit test zoom-invariant annotations. (Type:
CGFloat
wrapped inNSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionPageZoomLevel
Swift
static let pageZoomLevel: Document.ObjectFinderOption
-
Option indicating if annotations that are part of a group should be included. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionAnnotationIncludedGrouped
Swift
static let annotationIncludedGrouped: Document.ObjectFinderOption
-
Will sort words/annotations (smaller words/annotations first). Also reverses z-order so annotations on top are returned first. Use for touch detection. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionSmartSort
Swift
static let smartSort: Document.ObjectFinderOption
-
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. (Type:
CGFloat
wrapped inNSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionMinDiameter
Swift
static let minDiameter: Document.ObjectFinderOption
-
Will look at the text flow and select full sentences, not just what’s within the rect. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionTextFlow
Swift
static let textFlow: Document.ObjectFinderOption
-
Will stop after finding the first matching object. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionFindFirstOnly
Swift
static let findFirstOnly: Document.ObjectFinderOption
-
Only relevant for rect. Will test for intersection instead of objects that are fully included in the pdfRect. Defaults to YES if not set. (Type: Boolean wrapped in
NSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionTestIntersection
Swift
static let testIntersection: Document.ObjectFinderOption
-
Only relevant if
PSPDFObjectFinderOptionTestIntersection
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 andai
is the intersecting area, then the overlap proportion would be ai / (ao + ap - ai). (Type: double wrapped inNSNumber
)Declaration
Objective-C
extern const PSPDFObjectFinderOption _Nonnull PSPDFObjectFinderOptionTestIntersectionFraction
Swift
static let testIntersectionFraction: Document.ObjectFinderOption
-
Returns matching glyphs. Return type is NSArray
* Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeGlyphs
Swift
static let glyphs: Document.ObjectFinderType
-
Returns matching words. Return type is NSArray
* Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeWords
Swift
static let words: Document.ObjectFinderType
-
Returns matching text. Return type is NSString *
Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeText
Swift
static let text: Document.ObjectFinderType
-
Returns matching text blocks. Return type is NSArray
* Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeTextBlocks
Swift
static let textBlocks: Document.ObjectFinderType
-
Returns matching image info. Return type is NSArray
* Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeImages
Swift
static let images: Document.ObjectFinderType
-
Returns matching annotations. Return type is NSArray
* Declaration
Objective-C
extern const PSPDFObjectFinderType _Nonnull PSPDFObjectFinderTypeAnnotations
Swift
static let annotations: Document.ObjectFinderType
-
Set to @YES to force saving, even though there are no dirty objects. This is useful in combination with a rewrite, to remove unreferenced objects:
PSPDFDocumentSaveOptionStrategy = @(PSPDFDocumentSaveStrategyRewrite)
Declaration
Objective-C
extern const PSPDFDocumentSaveOption _Nonnull PSPDFDocumentSaveOptionForceSaving
Swift
static let forceSaving: PDFDocumentSaveOption
-
Defines the save strategy. Defaults to
PSPDFDocumentSaveStrategyAppend
Declaration
Objective-C
extern const PSPDFDocumentSaveOption _Nonnull PSPDFDocumentSaveOptionStrategy
Swift
static let strategy: PDFDocumentSaveOption
-
A
PSPDFDocumentSecurityOptions
instance, specifies the security options to use when saving the document. Not passing this options means the current security options will be used.Note
RequiresFeatures.documentEditing
to be part of your license.Declaration
Objective-C
extern const PSPDFDocumentSaveOption _Nonnull PSPDFDocumentSaveOptionSecurityOptions
Swift
static let securityOptions: PDFDocumentSaveOption
-
A
BOOL
value wrapped in anNSNumber
. If set to YES, applies all redactions in the document and removes the content underneath them. Not passing this option means redactions are not applied, and redaction annotations will stay in the document.Note
RequiresFeatures.redaction
to be part of your license.Declaration
Objective-C
extern const PSPDFDocumentSaveOption _Nonnull PSPDFDocumentSaveOptionApplyRedactions
Swift
static let applyRedactions: PDFDocumentSaveOption
-
A document posts an underlying file changed notification each time one of the backing files of the document is changed and the change did not originate from the document itself. When a file deletion can be detected, the same notification will be sent with a
PSPDFDocumentUnderlyingFileWillBeDeletedKey
in the user info. The notification will be sent on the main thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentUnderlyingFileChangedNotification
Swift
static let PSPDFDocumentUnderlyingFileChanged: NSNotification.Name
-
The underlying file url key identifies the file url of the changed file inside a
PSPDFDocumentUnderlyingFileChangedNotification
‘s user info dictionary. It is of typeURL
.Declaration
Objective-C
extern NS_SWIFT_NAME(changedFileURL) const PSPDFDocumentUnderlyingFileChangedNotificationOptions PSPDFDocumentUnderlyingFileURLKey
Swift
static let changedFileURL: Document.UnderlyingFileChangedNotificationOption
-
The underlying file url key identifies the data provider that registered the change inside a
PSPDFDocumentUnderlyingFileChangedNotification
‘s user info dictionary. It is of typeid<PSPDFCoordinatedFileDataProviding>
.Declaration
Objective-C
extern const PSPDFDocumentUnderlyingFileChangedNotificationOptions _Nonnull PSPDFDocumentUnderlyingDataProvider
Swift
static let dataProvider: Document.UnderlyingFileChangedNotificationOption
-
A boolean
NSNumber
indicating that the underlying file is about to be deleted.Declaration
Objective-C
extern NS_SWIFT_NAME(deleteFile) const PSPDFDocumentUnderlyingFileChangedNotificationOptions PSPDFDocumentUnderlyingFileWillBeDeletedKey
Swift
static let deleteFile: Document.UnderlyingFileChangedNotificationOption
-
Called before the document starts to save annotations. Use to save any unsaved changes.
Declaration
Objective-C
extern NS_SWIFT_NAME (Document.willSaveAnnotations) const NSNotificationName PSPDFDocumentWillSaveAnnotationsNotification
Swift
class let willSaveAnnotations: NSNotification.Name
-
NSUserDefaults
key for the default global annotation author name.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFDocumentDefaultAnnotationUsernameKey
Swift
let PSPDFDocumentDefaultAnnotationUsernameKey: String
-
Contains the boxed
PSPDFAnnotationType
to control appearance stream generation for each type.Declaration
Objective-C
extern const PSPDFAnnotationWriteOption _Nonnull PSPDFAnnotationWriteOptionGenerateAppearanceStreamForType
Swift
static let generateAppearanceStreamForType: Document.AnnotationWriteOption
-
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 aBOOL
wrapped in aNSNumber
) whether the checkpoint saved successfully or not.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFDocumentCheckpointSavedNotificationSuccessKey
Swift
let PSPDFDocumentCheckpointSavedNotificationSuccessKey: 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 outline (Table of Contents) controller.
Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionOutline
Swift
static let outline: DocumentInfoOption
-
Bookmark list controller.
Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionBookmarks
Swift
static let bookmarks: DocumentInfoOption
-
Annotation list controller. Requires
Features.annotationEditing
.Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionAnnotations
Swift
static let annotations: DocumentInfoOption
-
Embedded Files. Requires
Features.annotationEditing
.Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionEmbeddedFiles
Swift
static let embeddedFiles: DocumentInfoOption
-
Document Metadata.
Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionDocumentInfo
Swift
static let documentInfo: DocumentInfoOption
-
Document security options (permissions).
Declaration
Objective-C
extern const PSPDFDocumentInfoOption _Nonnull PSPDFDocumentInfoOptionSecurity
Swift
static let security: DocumentInfoOption
-
The constant to be used to indicate that the key length should be determined automatically.
Declaration
Objective-C
extern const NSUInteger PSPDFDocumentSecurityOptionsKeyLengthAutomatic
Swift
class let SecurityOptionsKeyLengthAutomatic: UInt
-
Printing the document.
Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationPrint
Swift
static let print: DocumentSharingConfiguration.Destination
-
The document is exported.
Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationExport
Swift
static let export: DocumentSharingConfiguration.Destination
-
The document is shared through the standard
UIActivityViewController
interface.Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationActivity
Swift
static let activity: DocumentSharingConfiguration.Destination
-
The document is shared through Messages.app directly. Attachment capabilities are required.
Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationMessages
Swift
static let messages: DocumentSharingConfiguration.Destination
-
The document is shared through Mail.app.
Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationEmail
Swift
static let email: DocumentSharingConfiguration.Destination
-
The document is shared through
UIDocumentInteractionController
.Declaration
Objective-C
extern const PSPDFDocumentSharingDestination _Nonnull PSPDFDocumentSharingDestinationOtherApplication
Swift
static let otherApplication: DocumentSharingConfiguration.Destination
-
Key for referencing the URL to which a document was exported to.
Declaration
Objective-C
extern const PSPDFDocumentSharingUserInfoKey _Nonnull PSPDFDocumentSharingExportedURL
Swift
static let exportedURL: PDFDocumentSharingUserInfoKey
-
Key for referencing the
UIDocumentPickerViewController
selected from the exporting interface.Declaration
Objective-C
extern const PSPDFDocumentSharingUserInfoKey _Nonnull PSPDFDocumentSharingSelectedDocumentPicker
Swift
static let selectedDocumentPicker: PDFDocumentSharingUserInfoKey
-
Key for referencing the activity type selected when sharing to the Activity destination (
UIActivityViewController
).Declaration
Objective-C
extern const PSPDFDocumentSharingUserInfoKey _Nonnull PSPDFDocumentSharingSelectedActivityType
Swift
static let selectedActivityType: PDFDocumentSharingUserInfoKey
-
Key for referencing the
UIPrintInteractionController
that handled the printing process when sharing to the Print destination.Declaration
Objective-C
extern const PSPDFDocumentSharingUserInfoKey _Nonnull PSPDFDocumentSharingPrintInteractionController
Swift
static let printInteractionController: PDFDocumentSharingUserInfoKey
-
These notifications represent a small subset of
UIDocumentInteractionControllerDelegate
(but the most important ones) To get all callbacks, checkPDFDocumentSharingViewController
and implement the appropriate delegates.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentInteractionControllerWillBeginSendingToApplicationNotification
Swift
static let PSPDFDocumentInteractionControllerWillBeginSendingToApplication: NSNotification.Name
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSNotificationName const PSPDFDocumentInteractionControllerDidEndSendingToApplicationNotification
Swift
static let PSPDFDocumentInteractionControllerDidEndSendingToApplication: NSNotification.Name
-
Posted when a spread view enters the bounds of the view.
A spread is considered visible if at least one pixel of it is inside the document view’s bounds.
Use
PSPDFDocumentViewControllerSpreadViewKey
to get the spread view in question from theuserInfo
dictionary on the notification.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentViewControllerWillBeginDisplayingSpreadViewNotification
Swift
static let PSPDFDocumentViewControllerWillBeginDisplayingSpreadView: NSNotification.Name
-
Posted when a spread view leaves the bounds of the view.
A spread is considered visible if at least one pixel of it is inside the document view’s bounds.
Use
PSPDFDocumentViewControllerSpreadViewKey
to get the spread view in question from theuserInfo
dictionary on the notification.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentViewControllerDidEndDisplayingSpreadViewNotification
Swift
static let PSPDFDocumentViewControllerDidEndDisplayingSpreadView: NSNotification.Name
-
Posted when a spread view is configured and added to the view hierarchy.
Use
PSPDFDocumentViewControllerSpreadViewKey
to get the spread view in question from theuserInfo
dictionary on the notification.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentViewControllerDidConfigureSpreadViewNotification
Swift
static let PSPDFDocumentViewControllerDidConfigureSpreadView: NSNotification.Name
-
Posted when a spread view is cleaned up and removed from the view hierarchy.
Use
PSPDFDocumentViewControllerSpreadViewKey
to get the spread view in question from theuserInfo
dictionary on the notification.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentViewControllerDidCleanupSpreadViewNotification
Swift
static let PSPDFDocumentViewControllerDidCleanupSpreadView: NSNotification.Name
-
The key on a notifications
userInfo
that holds the spread view that is relevant for the posted notification.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFDocumentViewControllerSpreadViewKey
Swift
let PSPDFDocumentViewControllerSpreadViewKey: String
-
Posted when the spread index changes.
Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFDocumentViewControllerSpreadIndexDidChangeNotification
Swift
static let PSPDFDocumentViewControllerSpreadIndexDidChange: NSNotification.Name
-
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 default intensity used for legacy lines without explicit intensity data.
Declaration
Objective-C
extern const CGFloat PSPDFDefaultIntensity
Swift
static let defaultIntensity: CGFloat
-
Point at location
CGPointZero
withintensity
0.
.Declaration
Objective-C
extern const PSPDFDrawingPoint PSPDFDrawingPointZero
Swift
static let zero: DrawingPoint
-
An invalid point with all components set to
NaN
.Declaration
Objective-C
extern const PSPDFDrawingPoint PSPDFDrawingPointNull
Swift
static let null: DrawingPoint
-
The PSPDFKit error domain.
Declaration
Objective-C
extern NSString *const _Nonnull PSPDFErrorDomain
Swift
let PSPDFErrorDomain: String
-
Paperclip icon.
Declaration
Objective-C
extern const PSPDFFileIconName _Nonnull PSPDFFileIconNamePaperclip
Swift
static let paperclip: FileAnnotation.IconName
-
Graph icon.
Declaration
Objective-C
extern const PSPDFFileIconName _Nonnull PSPDFFileIconNameGraph
Swift
static let graph: FileAnnotation.IconName
-
Tag icon.
Declaration
Objective-C
extern const PSPDFFileIconName _Nonnull PSPDFFileIconNameTag
Swift
static let tag: FileAnnotation.IconName
-
Pushpin icon.
Declaration
Objective-C
extern const PSPDFFileIconName _Nonnull PSPDFFileIconNamePushPin
Swift
static let pushPin: FileAnnotation.IconName
-
Specifies whether the file manager should use file coordination when performing operations. Expects a boolean NSNumber.
Declaration
Objective-C
extern const PSPDFFileManagerOption _Nonnull PSPDFFileManagerOptionCoordinatedAccess
Swift
static let coordinatedAccess: DefaultFileManager.Option
-
The optional
NSFilePresenter
object to pass to the internally createdNSFileCoordinator
when performing coordinated operations. See theNSFileCoordinator
documentation for details. This is only relevant whenPSPDFFileManagerOptionCoordinatedAccess
is enabled.Declaration
Objective-C
extern const PSPDFFileManagerOption _Nonnull PSPDFFileManagerOptionFilePresenter
Swift
static let filePresenter: DefaultFileManager.Option
-
The minimum acceptable font to be used when editing fields with autosizing fonts.
Declaration
Objective-C
static const CGFloat PSPDFMinimumAcceptableFontSize = 5.0
Swift
let PSPDFMinimumAcceptableFontSize: CGFloat
-
Notification when someone pressed “Clear Field”.
Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFFormInputAccessoryViewDidPressClearButtonNotification
Swift
static let PSPDFFormInputAccessoryViewDidPressClearButton: NSNotification.Name
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSNotificationName const PSPDFFormSubmissionControllerDidStartLoadingNotification
Swift
static let PSPDFFormSubmissionControllerDidStartLoading: NSNotification.Name
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSNotificationName const PSPDFFormSubmissionControllerDidFinishLoadingNotification
Swift
static let PSPDFFormSubmissionControllerDidFinishLoading: NSNotification.Name
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSNotificationName const PSPDFFormSubmissionControllerDidFailToLoadNotification
Swift
static let PSPDFFormSubmissionControllerDidFailToLoad: NSNotification.Name
-
Notification when someone presses “Clear”.
Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFFreeTextAccessoryViewDidPressClearButtonNotification
Swift
static let PSPDFFreeTextAccessoryViewDidPressClearButton: NSNotification.Name
-
NSValueTransformer
to convert betweenPSPDFFreeTextAnnotationIntent
enum and string value.Note
The transformer is added in the class initialize phase. RequiresFreeTextAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(freeTextAnnotationIntent) const NSValueTransformerName PSPDFFreeTextAnnotationIntentTransformerName
Swift
static let freeTextAnnotationIntent: NSValueTransformerName
-
Notification. Posted when the
contentState
of aPSPDFGalleryItem
changes.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFGalleryItemContentStateDidChangeNotification
Swift
static let PSPDFGalleryItemContentStateDidChange: NSNotification.Name
-
String. The type of an item.
Declaration
Objective-C
extern const PSPDFGalleryItemProperty _Nonnull PSPDFGalleryItemPropertyType
Swift
static let type: GalleryItem.Property
-
String. The content URL of an item.
Declaration
Objective-C
extern const PSPDFGalleryItemProperty _Nonnull PSPDFGalleryItemPropertyContentURL
Swift
static let contentURL: GalleryItem.Property
-
String. The caption of an item.
Declaration
Objective-C
extern const PSPDFGalleryItemProperty _Nonnull PSPDFGalleryItemPropertyCaption
Swift
static let caption: GalleryItem.Property
-
String. The options of an item.
Declaration
Objective-C
extern const PSPDFGalleryItemProperty _Nonnull PSPDFGalleryItemPropertyOptions
Swift
static let options: GalleryItem.Property
-
Boolean. Indicates if the content should automatically start playing.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionAutoplay
Swift
static let autoplay: GalleryItem.Option
-
Boolean. Indicates if controls should be displayed.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionControls
Swift
static let controls: GalleryItem.Option
-
Boolean. Indicates if the content should loop forever.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionLoop
Swift
static let loop: GalleryItem.Option
-
Boolean. Indicates that the content can be presented fullscreen.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionFullscreen
Swift
static let fullscreen: GalleryItem.Option
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSErrorDomain const PSPDFGalleryManifestErrorDomain
Swift
let PSPDFGalleryManifestErrorDomain: String
-
NSString. Indicates the cover mode.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionCoverMode
Swift
static let coverMode: GalleryItem.Option
-
NSURL. Indicates which image should be presented as a cover view.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionCoverImage
Swift
static let coverImage: GalleryItem.Option
-
NSNumber. The time in the video where the preview should be captured.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionCoverPreviewCaptureTime
Swift
static let coverPreviewCaptureTime: GalleryItem.Option
-
NSArray. The preferred video qualities.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionPreferredVideoQualities
Swift
static let preferredVideoQualities: GalleryItem.Option
-
NSNumber. The start time of the video.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionStartTime
Swift
static let startTime: GalleryItem.Option
-
NSNumber. The end time of the video.
Declaration
Objective-C
extern const PSPDFGalleryOption _Nonnull PSPDFGalleryOptionEndTime
Swift
static let endTime: GalleryItem.Option
-
Mixed value. This is a mixture of boolean values and an URL to a cover image. Use
PSPDFGalleryOptionCoverImage
andPSPDFGalleryOptionCoverMode
instead.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFGalleryOptionCover
Swift
let PSPDFGalleryOptionCover: String
-
An NSRange representing an invalid range of
PSPDFGlyph
s.Declaration
Objective-C
extern const NSRange PSPDFInvalidGlyphRange
Swift
let InvalidGlyphRange: NSRange
-
The annotation string for comment marker annotations.
Declaration
Objective-C
extern const PSPDFAnnotationString _Nonnull PSPDFAnnotationStringInstantCommentMarker
Swift
static let instantCommentMarker: Annotation.Tool
-
Set this as
PSPDFInstantDocumentDescriptor.delayForSyncingLocalChanges
to disable automatic syncing of local changes.Note
Important: When using this constant, remember to also disable listening for server changes to avoid nasty surprises! Instant’s sync operations are always two-way, so any incoming changes from the server would cause your local changes to be sent to the server.
If you are usingPSPDFInstantViewController
, that means you should setshouldListenForServerChangesWhenVisible
tofalse
. If you are using your own customPDFViewController
subclass to display documents, you should refrain from using the-[PSPDFInstantDocumentDescriptor startListeningForServerChanges]
API in such configurations. (As these calls need to be balanced, you really shouldn’t be calling-[PSPDFInstantDocumentDescriptor stopListeningForServerChanges]
in that case either.)For more details on the sync cycle, refer to the documentation of
PSPDFInstantDocumentState
.Declaration
Objective-C
extern const NSTimeInterval PSPDFInstantSyncingLocalChangesDisabled
Swift
let InstantSyncingLocalChangesDisabled: TimeInterval
-
Key for
NSNotification.userInfo
dictionary.Where supported, the value under this key will be an instance of
NSError
.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFInstantErrorKey
Swift
let PSPDFInstantErrorKey: String
-
Key for
NSNotification.userInfo
dictionary.Where supported, the value under this key will be an instance of
NSString
.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFInstantJWTKey
Swift
let PSPDFInstantJWTKey: String
-
Notification posted when downloading a PDF file from the server finishes.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
whose download completed.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFinishDownloadNotification
Swift
static let PSPDFInstantDidFinishDownload: NSNotification.Name
-
Notification posted when downloading the PDF file from the server fails.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
whose download failed. The error that occurred (NSError
) is available underPSPDFInstantErrorKey
in theuserInfo
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFailDownloadNotification
Swift
static let PSPDFInstantDidFailDownload: NSNotification.Name
-
Notification that is posted when a sync cycle begins.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that started syncing. A sync cycle ends with posting either aPSPDFInstantDidFailSyncingNotification
in case an error occurs, or with aPSPDFInstantDidFinishSyncingNotification
when all local changes have been synced successfully.
While the sync cycle is running, any number ofPSPDFInstantSyncCycleDidChangeStateNotification
s can be posted.For more details on the sync cycle, refer to the documentation of
PSPDFInstantDocumentState
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidBeginSyncingNotification
Swift
static let PSPDFInstantDidBeginSyncing: NSNotification.Name
-
Notification that is posted when a sync cycle changes its state.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that changed its sync state. Any number of these notifications can be posted while the sync cycle is running.For more details on the sync cycle, refer to the documentation of
PSPDFInstantDocumentState
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantSyncCycleDidChangeStateNotification
Swift
static let PSPDFInstantSyncCycleDidChangeState: NSNotification.Name
-
Notification that is posted when a sync cycle completes with an error.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that failed synchronization. The error that occurred (NSError
) is available underPSPDFInstantErrorKey
in theuserInfo
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFailSyncingNotification
Swift
static let PSPDFInstantDidFailSyncing: NSNotification.Name
-
Notification that is posted when a sync cycle completes successfully.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that has been synced.For more details on the sync cycle, refer to the documentation of
PSPDFInstantDocumentState
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFinishSyncingNotification
Swift
static let PSPDFInstantDidFinishSyncing: NSNotification.Name
-
Notification posted when Instant fails to authenticate with the PSPDFKit Server to synchronize annotations.
This notification typically means that the user no longer has access to the document or that the JWT expired. You should ask your backend server for a new JWT for this document identifier and, if the user should still be allowed to access that document, pass the new JWT into
-[PSPDFInstantDocumentDescriptor reauthenticateWithJWT:]
. If your backend server decided that the user no longer has access, stop showing this document to the user and call-[PSPDFInstantDocumentDescriptor removeLocalStorageWithError:]
instead.The object of this notification will be the
PSPDFInstantDocumentDescriptor
that could not be authenticated.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFailAuthenticationNotification
Swift
static let PSPDFInstantDidFailAuthentication: NSNotification.Name
-
Notification posted when the authentication token for a document has been successfully updated.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that has been reauthenticated. The accepted JWT is available as anNSString
underPSPDFInstantJWTKey
in the notification’suserInfo
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFinishReauthenticationNotification
Swift
static let PSPDFInstantDidFinishReauthentication: NSNotification.Name
-
Notification posted when the authentication token for a document could not be updated.
The object of this notification will be the
PSPDFInstantDocumentDescriptor
that could not be reauthenticated. The error that occurred is available underPSPDFInstantErrorKey
in the notification’suserInfo
.Note
Important: This notification will be posted on a background thread.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFInstantDidFailReauthenticationNotification
Swift
static let PSPDFInstantDidFailReauthentication: NSNotification.Name
-
Domain for errors encountered by PSPDFKit Instant.
Declaration
Objective-C
extern const NSErrorDomain _Nonnull PSPDFInstantErrorDomain
Swift
let PSPDFInstantErrorDomain: String
-
Key for
NSError
userInfo
for thePSPDFInstantDocumentDescriptorDescriptor
an error relates to, if applicable.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFInstantErrorDocumentDescriptorKey
Swift
let PSPDFInstantErrorDocumentDescriptorKey: String
-
Key for
NSError
userInfo
for theDocument
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 ofPSPDFInstantErrorDatabaseAccessFailed
.A detailed discussions of these codes can be found at https://www.sqlite.org/rescode.html
Note
Important: This value can very well benil
! (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
orPSPDFInstantErrorNoSuchAttachment
.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
-
X-Callback URL, see http://x-callback-url.com
Note
This is used for the Chrome activity inPSPDFWebViewController
. Example:PSPDFKitGlobal.sharedInstance[PSPDFSettingKeyXCallbackURLString] = @"pspdfcatalog://";
Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyXCallbackURLString
-
Custom PSPDFApplicationPolicy instance that can be configured with
setLicenseKey:options:
.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyApplicationPolicy
-
Custom PSPDFFileManager instance that can be configured with
setLicenseKey:options:
.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyFileManager
-
Custom coordinated PSPDFFileManager instance that can be configured with
setLicenseKey:options:
.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyCoordinatedFileManager
-
Specifies whether coordinated file operations are used by default in
Document
. CreatesPSPDFCoordinatedFileDataProvider
s when initializing documents with local URLs. Expects a booleanNSNumber
. Defaults to@YES
. Set to@NO
to disable.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyFileCoordinationEnabled
-
Specifies the indexing priority that the shared
PSPDFLibrary
instance must use. Must be a validPSPDFLibraryIndexingPriority
value wrapped in aNSNumber
. SeePSPDFLibraryIndexingPriority
for details.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyLibraryIndexingPriority
-
Enables various debug UI options. (e.g. more settings)
Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyDebugMode
-
Allows specifying additional font directories at initialization time. Expects an array of strings.
Some PDFs don’t contain embedded fonts and sometimes the system fonts don’t provide a good enough replacement. In that case, you can ship your own fonts and point PSPDFKit to your additional font directories when you initialize the
SDK
object.Example:
let pdfSDK = PSPDFKit.SDK(licenseKey: "Your License goes here", options: [ .additionalFontDirectories: [/* your directory paths */], /* any other customisations */ ])
Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyAdditionalFontDirectories
-
Specifies whether
Document
permissions are honored in the PSPDFKit UI.PSPDFKit
will honor certain PDF permissions and prevent corresponding UI actions, such as editing annotations, if the document disallows them. This option can be used to globally disable this behavior and instead allow all configured UI actions regardless of document permissions.Note
This option will affect the output ofPSPDFDocument.features
whilePSPDFDocument.permissions
will still reflect the actual values configured in the PDF document. For documents that were instantiated before changing this option,[document.features updateFeatures]
needs to be invoked to ensure the changes are correctly reflected in the features system.Expects a boolean
NSNumber
. Defaults to@YES
. Set to@NO
to disable.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyHonorDocumentPermissions
-
This option will reduce memory usage at the expense of performance.
When enabled PSPDFKit will reduce memory caches and disable optimizations such as parallel document rendering. This option should be avoided, unless you’re working with extreme memory constraints.
Note
Set this before the framework is initialized, as part of the license key call.Declaration
Objective-C
extern const PSPDFSettingKey _Nonnull PSPDFSettingKeyLowMemoryMode
-
The library version.
Declaration
Objective-C
extern const NSUInteger PSPDFLibraryVersion
Swift
let PSPDFLibraryVersion: UInt
-
Posted when the library begins indexing a document.
The
object
of this notification will be thePDFLibrary
instance that posts it. The UID of the document about to be indexed can be found in theuserInfo
underPSPDFLibraryNotificationUIDKey
.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFLibraryWillStartIndexingDocumentNotification
Swift
static let PSPDFLibraryWillStartIndexingDocument: NSNotification.Name
-
Posted when the library completed or failed indexing a document.
The
object
of this notification will be thePDFLibrary
instance that posts it. The UID of the indexed document can be found in theuserInfo
underPSPDFLibraryNotificationUIDKey
, whilePSPDFLibraryNotificationSuccessKey
holds aBool
, indicting whether indexing completed successfully.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFLibraryDidFinishIndexingDocumentNotification
Swift
static let PSPDFLibraryDidFinishIndexingDocument: NSNotification.Name
-
Posted when the library removed a document from the index.
The
object
of this notification will be thePDFLibrary
instance that posts it. The UID of the indexed document can be found in theuserInfo
underPSPDFLibraryNotificationUIDKey
.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFLibraryDidRemoveDocumentNotification
Swift
static let PSPDFLibraryDidRemoveDocument: NSNotification.Name
-
Posted when the library did complete clearing all its indexes.
The
object
of this notification will be thePDFLibrary
on whichclearAllIndexes()
has been called. NouserInfo
will be provided.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFLibraryDidClearIndexesNotification
Swift
static let PSPDFLibraryDidClearIndexes: NSNotification.Name
-
In document-specific notifications posted by
PDFLibrary
, theuserInfo
key under which the UID of that document can be found.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFLibraryNotificationUIDKey
Swift
let PSPDFLibraryNotificationUIDKey: String
-
In
PSPDFLibraryDidFinishIndexingDocumentNotification
, theuserInfo
key holding the success state of the operation as aBool
.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 thePSPDFLibrary.tokenizer
property will result in an error when trying to create the library.Declaration
Objective-C
extern NS_SWIFT_NAME(PDFLibrary.UnicodeTokenizerName) NSString *const PSPDFLibraryUnicodeTokenizerName
Swift
class let UnicodeTokenizerName: String
-
Option keys. Limit the number of document results.
Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionMaximumSearchResultsTotal
Swift
static let maximumSearchResultsTotal: PDFLibrary.Option
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFLibraryOption const PSPDFLibraryOptionMaximumSearchResultsPerDocument
Swift
static let maximumSearchResultsPerDocument: PDFLibrary.Option
-
Limit the number of preview results.
Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionMaximumPreviewResultsTotal
Swift
static let maximumPreviewResultsTotal: PDFLibrary.Option
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFLibraryOption const PSPDFLibraryOptionMaximumPreviewResultsPerDocument
Swift
static let maximumPreviewResultsPerDocument: PDFLibrary.Option
-
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 differenttokenizer
. See https://pspdfkit.com/guides/ios/features/indexed-full-text-search/Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionMatchExactWordsOnly
Swift
static let matchExactWordsOnly: PDFLibrary.Option
-
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 differenttokenizer
. See https://pspdfkit.com/guides/ios/features/indexed-full-text-search/Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionMatchExactPhrasesOnly
Swift
static let matchExactPhrasesOnly: PDFLibrary.Option
-
Set this to @YES to exclude annotations from the search. By default, indexed annotations will be searched.
Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionExcludeAnnotations
Swift
static let excludeAnnotations: PDFLibrary.Option
-
Set this to @YES to exclude document text from the search. By default, indexed document text will be searched.
Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionExcludeDocumentText
Swift
static let excludeDocumentText: PDFLibrary.Option
-
Customizes the range of the preview string. Defaults to 20/160.
Declaration
Objective-C
extern const PSPDFLibraryOption _Nonnull PSPDFLibraryOptionPreviewRange
Swift
static let previewRange: PDFLibrary.Option
-
Posted when the media player started playing. Notification includes the
PSPDFMediaPlayerController
.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFMediaPlayerControllerPlaybackDidStartNotification
Swift
static let PSPDFMediaPlayerControllerPlaybackDidStart: NSNotification.Name
-
Posted when the media player paused. Notification includes the
PSPDFMediaPlayerController
.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFMediaPlayerControllerPlaybackDidPauseNotification
Swift
static let PSPDFMediaPlayerControllerPlaybackDidPause: NSNotification.Name
-
Posted when the media player finished playing the entire video. Notification includes the
PSPDFMediaPlayerController
.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFMediaPlayerControllerPlaybackDidFinishNotification
Swift
static let PSPDFMediaPlayerControllerPlaybackDidFinish: NSNotification.Name
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use the modern menu system instead.
PSPDFMenuItem
adds support for image-based menu items, and although it doesn’t use any private API, it does require some method swizzling. You can disable this feature by setting this variable tofalse
before you present a legacy menu for the first time. Default:true
.Warning
This variable is deprecated. Image-based menu actions are supported in the modern menu system by default. Please see our Customizing Menus guide to learn more.
Declaration
Objective-C
extern BOOL PSPDFAllowImagesForMenuItems
Swift
var PSPDFAllowImagesForMenuItems: ObjCBool
-
Metadata key for the document title. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(title) const PSPDFMetadataName PSPDFMetadataTitleKey
-
Metadata key for the document author. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(author) const PSPDFMetadataName PSPDFMetadataAuthorKey
-
Metadata key for the document subject. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(subject) const PSPDFMetadataName PSPDFMetadataSubjectKey
-
Metadata key for the document keywords. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(keywords) const PSPDFMetadataName PSPDFMetadataKeywordsKey
-
Metadata key for the document creator. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(creator) const PSPDFMetadataName PSPDFMetadataCreatorKey
-
Metadata key for the document producer. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(producer) const PSPDFMetadataName PSPDFMetadataProducerKey
-
Metadata key for the document creation date. Object will be of type Date.
Declaration
Objective-C
extern NS_SWIFT_NAME(creationDate) const PSPDFMetadataName PSPDFMetadataCreationDateKey
-
Metadata key for the document modification date. Object will be of type Date.
Declaration
Objective-C
extern NS_SWIFT_NAME(modificationDate) const PSPDFMetadataName PSPDFMetadataModDateKey
-
Metadata key for the document’s trapped value. Object will be of type String.
Declaration
Objective-C
extern NS_SWIFT_NAME(trapped) const PSPDFMetadataName PSPDFMetadataTrappedKey
-
Transforms named actions to enum type and back.
Note
The transformer is added in the class initialize phase. RequiresPSPDFNamedAction
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(namedActionType) const NSValueTransformerName PSPDFNamedActionTypeTransformerName
Swift
static let namedActionType: NSValueTransformerName
-
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
-
Specifies a blank page.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierBlank
Swift
static let blank: PageTemplate.Identifier
-
Specifies a pattern for a new page with a dot grid that is 5mm apart.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierDot5mm
Swift
static let dot5mm: PageTemplate.Identifier
-
Specifies a pattern for a new page with a grid that is 5mm apart.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierGrid5mm
Swift
static let grid5mm: PageTemplate.Identifier
-
Specifies a pattern for a new page with lines that are 5mm apart.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierLines5mm
Swift
static let lines5mm: PageTemplate.Identifier
-
Specifies a pattern for a new page with lines that are 7mm apart.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierLines7mm
Swift
static let lines7mm: PageTemplate.Identifier
-
Specifies a pattern for a new page with image.
Declaration
Objective-C
extern const PSPDFTemplateIdentifier _Nonnull PSPDFTemplateIdentifierImage
Swift
static let image: PageTemplate.Identifier
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use ‘UIAction.Identifier.PSPDFKit.copy’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuCopy
Swift
static let copy: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuCreateLink
Swift
static let createLink: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use ‘UIAction.Identifier.PSPDFKit.define’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuDefine
Swift
static let define: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuPause
Swift
static let pause: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use ‘UIAction.Identifier.PSPDFKit.saveAs’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuSaveAs
Swift
static let saveAs: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use ‘UIAction.Identifier.PSPDFKit.searchDocument’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuSearch
Swift
static let search: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Use ‘UIAction.Identifier.PSPDFKit.share’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuShare
Swift
static let share: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuSpeak
Swift
static let speak: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFTextMenuWikipedia
Swift
static let wikipedia: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuHighlight
Swift
static let annotationMenuHighlight: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuRedaction
Swift
static let annotationMenuRedaction: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuSquiggle
Swift
static let annotationMenuSquiggle: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuStrikeout
Swift
static let annotationMenuStrikeout: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuUnderline
Swift
static let annotationMenuUnderline: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuAlignment
Swift
static let annotationMenuAlignment: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuAlignmentCenter
Swift
static let annotationMenuAlignmentCenter: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuAlignmentLeft
Swift
static let annotationMenuAlignmentLeft: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuAlignmentRight
Swift
static let annotationMenuAlignmentRight: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuBlendMode
Swift
static let annotationMenuBlendMode: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuCancel
Swift
static let annotationMenuCancel: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuColor
Swift
static let annotationMenuColor: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuContinueRecording
Swift
static let annotationMenuContinueRecording: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.copy’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuCopy
Swift
static let annotationMenuCopy: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuCustomColor
Swift
static let annotationMenuCustomColor: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.editFreeText’ or ‘UIAction.Identifier.PSPDFKit.editSound’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuEdit
Swift
static let annotationMenuEdit: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuFillColor
Swift
static let annotationMenuFillColor: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuFinishRecording
Swift
static let annotationMenuFinishRecording: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.sizeToFit’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuFitToText
Swift
static let annotationMenuFitToText: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuFont
Swift
static let annotationMenuFont: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.group’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuGroup
Swift
static let annotationMenuGroup: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIMenu.Identifier.PSPDFKit.type’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuHighlightType
Swift
static let annotationMenuHighlightType: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.inspector’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuInspector
Swift
static let annotationMenuInspector: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineEnd
Swift
static let annotationMenuLineEnd: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineStart
Swift
static let annotationMenuLineStart: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeButt
Swift
static let annotationMenuLineTypeButt: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeCircle
Swift
static let annotationMenuLineTypeCircle: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeClosedArrow
Swift
static let annotationMenuLineTypeClosedArrow: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeDiamond
Swift
static let annotationMenuLineTypeDiamond: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeNone
Swift
static let annotationMenuLineTypeNone: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeOpenArrow
Swift
static let annotationMenuLineTypeOpenArrow: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeReverseClosedArrow
Swift
static let annotationMenuLineTypeReverseClosedArrow: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeReverseOpenArrow
Swift
static let annotationMenuLineTypeReverseOpenArrow: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeSlash
Swift
static let annotationMenuLineTypeSlash: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuLineTypeSquare
Swift
static let annotationMenuLineTypeSquare: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.merge’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuMerge
Swift
static let annotationMenuMerge: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.comments’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuNote
Swift
static let annotationMenuNote: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuOpacity
Swift
static let annotationMenuOpacity: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.paste’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuPaste
Swift
static let annotationMenuPaste: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuPause
Swift
static let annotationMenuPause: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuPauseRecording
Swift
static let annotationMenuPauseRecording: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.play’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuPlay
Swift
static let annotationMenuPlay: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.previewFile’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuPreviewFile
Swift
static let annotationMenuPreviewFile: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.delete’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuRemove
Swift
static let annotationMenuRemove: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.store’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuSave
Swift
static let annotationMenuSave: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuSize
Swift
static let annotationMenuSize: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIMenu.Identifier.PSPDFKit.style’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuStyle
Swift
static let annotationMenuStyle: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. This value is unused in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuThickness
Swift
static let annotationMenuThickness: TextMenu
-
Deprecated
Deprecated in PSPDFKit 12 for iOS. Use ‘UIAction.Identifier.PSPDFKit.ungroup’ in the modern menu system.
Undocumented
Declaration
Objective-C
PSPDF_EXPORT const PSPDFTextMenu PSPDFAnnotationMenuUngroup
Swift
static let annotationMenuUngroup: TextMenu
-
The notification posted when
selectedAnnotations
property changes. The object of this notification is thePSPDFPageView
whoseselectedAnnotations
property changed. This notification has no user info.Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFPageViewSelectedAnnotationsDidChangeNotification
Swift
static let PSPDFPageViewSelectedAnnotationsDidChange: NSNotification.Name
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Observe ‘Notification.Name.PSPDFAnnotationsAdded’ instead.
The notificiation posted when annotations are inserted. The object of this notification is always
nil
. This notification has the following user info keys:PSPDFAnnotationCreateActionInsertedAnnotationsKey
.Warning
This notification is deprecated. To be notified when annotations are added to a document, usePSPDFAnnotationsAddedNotification
instead.Declaration
Objective-C
extern PSPDF_DEPRECATED( 12.3, "Observe 'Notification.Name.PSPDFAnnotationsAdded' instead.") const NSNotificationName PSPDFAnnotationCreateActionDidInsertNotification
Swift
static let PSPDFAnnotationCreateActionDidInsert: NSNotification.Name
-
Deprecated
Deprecated in PSPDFKit 12.3 for iOS. Observe ‘Notification.Name.PSPDFAnnotationsAdded’ instead.
The user info key for
PSPDFAnnotationCreateActionDidInsertNotification
. The value for this key is an array ofPSPDFAnnotation
objects that were inserted.Warning
This user info key is deprecated. To be notified when annotations are added to a document, usePSPDFAnnotationsAddedNotification
instead.Declaration
Objective-C
extern PSPDF_DEPRECATED( 12.3, "Observe 'Notification.Name.PSPDFAnnotationsAdded' instead.") NSString *const PSPDFAnnotationCreateActionInsertedAnnotationsKey
Swift
let PSPDFAnnotationCreateActionInsertedAnnotationsKey: String
-
NSValueTransformer
to convert betweenPSPDFPolygonAnnotationIntent
enum and string value.Note
The transformer is added in the class initialize phase. RequiresPSPDFPolygonAnnotation
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(polygonAnnotationIntent) const NSValueTransformerName PSPDFPolygonAnnotationIntentTransformerName
Swift
static let polygonAnnotationIntent: NSValueTransformerName
-
Presentation style.
Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionPresentationStyle
Swift
static let presentationStyle: PresentationOption
-
User interface style for the contents when presenting in a half-modal or a popover.
Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionHalfModalStyle
Swift
static let halfModalStyle: PresentationOption
-
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 const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionNonAdaptive
Swift
static let nonAdaptive: PresentationOption
-
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 aCGRect
. This works if the container view resizes, so is preferred over the rectangle inPSPDFPresentationOptionSourceRect
.Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionSourceRectProvider
Swift
static let sourceRectProvider: PresentationOption
-
A convenience for setting the presented view controller’s
preferredContentSize
just before it is presented.Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionContentSize
Swift
static let contentSize: PresentationOption
-
Set to YES to embed the controller in a navigation controller. If the controller is already a navigation controller, no change is made. This option is inferred if a close button should be added due to
PSPDFPresentationOptionCloseButton
being set.Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionInNavigationController
Swift
static let inNavigationController: PresentationOption
-
Set to YES to add a close button that dismisses the presented view controller. This implies embedding in a navigation controller so it’s not necessary to also set
PSPDFPresentationOptionInNavigationController
.Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionCloseButton
Swift
static let closeButton: PresentationOption
-
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 const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionReuseNavigationController
Swift
static let reuseNavigationController: PresentationOption
-
Customize default arrow directions for popover.
Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionPopoverArrowDirections
Swift
static let popoverArrowDirections: PresentationOption
-
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 const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionPopoverPassthroughViews
Swift
static let popoverPassthroughViews: PresentationOption
-
Customize the popover backdrop view background color (includes the arrow color).
Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionPopoverBackgroundColor
Swift
static let popoverBackgroundColor: PresentationOption
-
The presentation source rectangle, used for popovers and half modal presentations. This is interpreted relative to the source view controller’s view.
PSPDFPresentationOptionSourceRectProvider
is preferred.Declaration
Objective-C
extern const PSPDFPresentationOption _Nonnull PSPDFPresentationOptionSourceRect
Swift
static let sourceRect: PresentationOption
-
Available keys for options.
PSPDFProcessorAnnotationDictKey
in form of pageIndex -> annotations. Annotations will be flattened when type is set, unlessPSPDFProcessorAnnotationAsDictionaryKey
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 optionallyPSPDFRenderManagerRenderResultChangedPagesKey
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 theDocument
that was changed.Declaration
Objective-C
extern NSString *const _Nonnull PSPDFRenderManagerRenderResultChangedDocumentKey
Swift
let PSPDFRenderManagerRenderResultChangedDocumentKey: String
-
The key of a
PSPDFRenderManagerRenderResultDidChangeNotification
userInfo’s dictionary, containing anNSIndexSet
with all the relevant pages. If the entry for this key in the user info dictionary isnil
, 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
-
Transforms a rendition action type enum to string and back.
Note
The transformer is added in the class initialize phase. RequiresPSPDFRenditionAction
to be accessed at least once.Declaration
Objective-C
extern NS_SWIFT_NAME(renditionActionType) const NSValueTransformerName PSPDFRenditionActionTypeTransformerName
Swift
static let renditionActionType: NSValueTransformerName
-
Constant used to always force guide snapping.
Declaration
Objective-C
extern const CGFloat PSPDFGuideSnapAllowanceAlways
Swift
let PSPDFGuideSnapAllowanceAlways: CGFloat
-
The default store name PSPDFKit uses for the
KeychainSignatureStore
when using the initializer with no parameters.Declaration
Objective-C
extern NS_SWIFT_NAME(KeychainSignatureStore.DefaultStoreName) NSString *PSPDFKeychainSignatureStoreDefaultStoreName
Swift
class let DefaultStoreName: String
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT NSString *const PSPDFSignerErrorDomain
Swift
let PSPDFSignerErrorDomain: String
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFSoundAnnotationEncoding const PSPDFSoundAnnotationEncodingRaw
Swift
static let raw: SoundAnnotation.Encoding
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFSoundAnnotationEncoding const PSPDFSoundAnnotationEncodingSigned
Swift
static let signed: SoundAnnotation.Encoding
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFSoundAnnotationEncoding const PSPDFSoundAnnotationEncodingMuLaw
Swift
static let muLaw: SoundAnnotation.Encoding
-
Undocumented
Declaration
Objective-C
PSPDF_EXPORT PSPDFSoundAnnotationEncoding const PSPDFSoundAnnotationEncodingALaw
Swift
static let aLaw: SoundAnnotation.Encoding
-
Posted when recording or playback is started, paused or stopped.
Declaration
Objective-C
extern const NSNotificationName _Nonnull PSPDFSoundAnnotationChangedStateNotification
Swift
static let PSPDFSoundAnnotationChangedState: NSNotification.Name