CPDFAttachmentAnnotation Class Reference

Inherits from CPDFAnnotation : NSObject
Declared in CPDFAttachmentAnnotation.h

Overview

A CPDFAttachmentAnnotation object represents a file attachment annotation.

– setEmbeddedFileAtPath:attachName:

Sets an embedded file attachment for the annotation.

- (BOOL)setEmbeddedFileAtPath:(NSString *_Nullable)filePath attachName:(NSString *_Nullable)attachName

Parameters

filePath

The full file path to embed.

attachName

The attachment display name.

Return Value

YES if succeeded.

Discussion

Sets an embedded file attachment for the annotation.

Declared In

CPDFAttachmentAnnotation.h

– saveEmbeddedFileToPath:

Saves the embedded file attachment to a target path.

- (BOOL)saveEmbeddedFileToPath:(NSString *_Nullable)filePath

Parameters

filePath

The target path to save to.

Return Value

YES if succeeded.

Discussion

Saves the embedded file attachment to a target path.

Declared In

CPDFAttachmentAnnotation.h

– removeEmbeddedFileAttachment

Removes the embedded file attachment from the annotation.

- (BOOL)removeEmbeddedFileAttachment

Return Value

YES if succeeded.

Discussion

Removes the embedded file attachment from the annotation.

Declared In

CPDFAttachmentAnnotation.h