PSPDFDocumentSharingAnnotationOptions
Objective-C
NS_OPTIONS(NSUInteger, PSPDFDocumentSharingAnnotationOptions) {
/// Save annotations in the PDF.
///
/// Embed annotations into the PDF.
///
/// @warning When using this option for printing, no annotations may be printed. This is a result of internal limitations of the printing system on iOS.
/// @see [3rd-Party Compatibility](https://pspdfkit.com/guides/ios/miscellaneous/3rd-party-compatibility/)
PSPDFDocumentSharingAnnotationOptionEmbed = 1 << 0,
/// Render annotations into the PDF.
PSPDFDocumentSharingAnnotationOptionFlatten = 1 << 1,
/// Similar to `PSPDFDocumentSharingAnnotationOptionFlatten`, but renders annotations
/// into the PDF with applied visibility settings for printing and converts notes to printable text.
///
/// @note Use this option to ensure `PSPDFAnnotationFlagPrint` is correctly applied. If annotations
/// are passed to the iOS printing service without previous flattening, visibility flags might not be
/// honored correctly and annotations might appear different than in PSPDFKit.
PSPDFDocumentSharingAnnotationOptionFlattenForPrint = 1 << 2,
/// Save annotations + add summary. Not available on macOS.
PSPDFDocumentSharingAnnotationOptionSummary = 1 << 3,
/// Remove all annotations.
PSPDFDocumentSharingAnnotationOptionRemove = 1 << 4
}
Swift
struct AnnotationOptions : OptionSet, @unchecked Sendable
Undocumented
-
Save annotations in the PDF.
Embed annotations into the PDF. - warning: When using this option for printing, no annotations may be printed. This is a result of internal limitations of the printing system on iOS. - see: [3rd-Party Compatibility](https://pspdfkit.com/guides/ios/miscellaneous/3rd-party-compatibility/)
Declaration
Objective-C
PSPDFDocumentSharingAnnotationOptionEmbed = 1 << 0
Swift
static var embed: DocumentSharingConfiguration.AnnotationOptions { get }
-
Render annotations into the PDF.
Declaration
Objective-C
PSPDFDocumentSharingAnnotationOptionFlatten = 1 << 1
Swift
static var flatten: DocumentSharingConfiguration.AnnotationOptions { get }
-
Similar to
PSPDFDocumentSharingAnnotationOptionFlatten
, but renders annotations into the PDF with applied visibility settings for printing and converts notes to printable text.- note: Use this option to ensure `PSPDFAnnotationFlagPrint` is correctly applied. If annotations are passed to the iOS printing service without previous flattening, visibility flags might not be honored correctly and annotations might appear different than in PSPDFKit.
Declaration
Objective-C
PSPDFDocumentSharingAnnotationOptionFlattenForPrint = 1 << 2
Swift
static var flattenForPrint: DocumentSharingConfiguration.AnnotationOptions { get }
-
Save annotations + add summary. Not available on macOS.
Declaration
Objective-C
PSPDFDocumentSharingAnnotationOptionSummary = 1 << 3
Swift
static var summary: DocumentSharingConfiguration.AnnotationOptions { get }
-
Remove all annotations.
Declaration
Objective-C
PSPDFDocumentSharingAnnotationOptionRemove = 1 << 4
Swift
static var remove: DocumentSharingConfiguration.AnnotationOptions { get }