PTToolManager

@interface PTToolManager : UIView <PTOverridable, PTPDFViewCtrlToolDelegate,
                                   PTToolEvents, PTToolOptionsDelegate>

The PTToolManager class is responsbile for forwarding events from the PDFViewCtrl to Tools, and coordinating the control and data flow between tools.


                    
                    
                    tool

The current tool.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable) PTTool *tool;

Swift

var tool: PTTool? { get set }


                    
                    
                    delegate

An object that conforms to the PTToolManagerDelegate protocol.

Declaration

Objective-C

@property (readwrite, nonatomic, nullable) id<PTToolManagerDelegate> delegate;

Swift

weak var delegate: PTToolManagerDelegate? { get set }


                    
                    
                    pdfViewCtrl

The PTPDFViewCtrl that the PTToolManager was initialized with.

Declaration

Objective-C

@property (readonly, nonatomic) PTPDFViewCtrl *_Nullable pdfViewCtrl;

Swift

weak var pdfViewCtrl: PTPDFViewCtrl? { get }


                    
                    
                    viewController

Undocumented

Declaration

Objective-C

@property (nonatomic, readonly, weak) UIViewController *viewController

Swift

weak var viewController: UIViewController? { get }


                    
                    
                    -initWithPDFViewCtrl:

Returns a newly initialized tool manager with the required pointer to the PTPDFViewCtrl on which it will operate.

Declaration

Objective-C

- (nonnull instancetype)initWithPDFViewCtrl:
    (nonnull PTPDFViewCtrl *)pdfViewCtrl;

Swift

init(pdfViewCtrl: PTPDFViewCtrl)

Parameters


                                pdfViewCtrl

a pointer to the PTPDFViewCtrl that the tool manager will operate.

Return Value

A newly initialized tool manager object.


                    
                    
                    -changeTool:

Create and set a new tool of the given type as the current tool.

Declaration

Objective-C

- (nonnull PTTool *)changeTool:(nonnull Class)toolType;

Swift

func changeTool(_ toolType: AnyClass) -> PTTool


                    
                    
                    -selectAnnotation:onPageNumber:

Selects the specified annotation.

Declaration

Objective-C

- (BOOL)selectAnnotation:(nullable PTAnnot *)annotation
            onPageNumber:(unsigned long)pageNumber;

Swift

func selectAnnotation(_ annotation: PTAnnot?, onPageNumber pageNumber: UInt) -> Bool

Parameters

`annotation`	the annotation to selected. If annotation is Nil, any selected annotation is deselected, and the tool is set to the default tool, typically PTPanTool.
`pageNumber`	the page number of the annotation

Return Value

YES if the annotation was selected, NO otherwise.


                    
                    
                    annotationAuthor

A string that will be used to set the author field of annotations that are created.

Declaration

Objective-C

@property (readwrite, copy, nonatomic, nullable) NSString *annotationAuthor;

Swift

var annotationAuthor: String? { get set }

showMenuOnTap
When true, the UIMenuController shows after a tap (in addition to after a long press). The default value of this property is false.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) BOOL showMenuOnTap;
Swift

var showMenuOnTap: Bool { get set }
showDefaultSignature
When true, the digital signature tool allows the user to save signatures and apply previously saved signatures.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) BOOL showDefaultSignature;
Swift

var showDefaultSignature: Bool { get set }


                    
                    
                    pageIndicatorEnabled

Whether the built-in page number indicator is enabled. The default value of this property is false.

Declaration

Objective-C

@property (getter=isPageIndicatorEnabled, assign, readwrite, nonatomic)
    BOOL pageIndicatorEnabled;

Swift

var isPageIndicatorEnabled: Bool { get set }

readonly
Whether the document associated with the PTPDFViewCtrl is read-only. The default value is NO.

When in read-only mode, annotation creation and editing are disabled as well as other actions that would modify the document.
Declaration
Objective-C

@property (getter=isReadonly, assign, readwrite, nonatomic) BOOL readonly;
Swift

var isReadonly: Bool { get set }

Annotation options


                    
                    
                    textAnnotationOptions

The options for text (PTExtendedAnnotTypeText) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTTextAnnotationOptions *_Nonnull textAnnotationOptions;

Swift

@NSCopying var textAnnotationOptions: PTTextAnnotationOptions { get set }


                    
                    
                    linkAnnotationOptions

The options for link (PTExtendedAnnotTypeLink) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull linkAnnotationOptions;

Swift

@NSCopying var linkAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    freeTextAnnotationOptions

The options for free text (PTExtendedAnnotTypeFreeText) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTFreeTextAnnotationOptions *_Nonnull freeTextAnnotationOptions;

Swift

@NSCopying var freeTextAnnotationOptions: PTFreeTextAnnotationOptions { get set }


                    
                    
                    lineAnnotationOptions

The options for line (PTExtendedAnnotTypeLine) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull lineAnnotationOptions;

Swift

@NSCopying var lineAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    squareAnnotationOptions

The options for square (PTExtendedAnnotTypeSquare) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull squareAnnotationOptions;

Swift

@NSCopying var squareAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    circleAnnotationOptions

The options for circle (PTExtendedAnnotTypeCircle) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull circleAnnotationOptions;

Swift

@NSCopying var circleAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    polygonAnnotationOptions

The options for polygon (PTExtendedAnnotTypePolygon) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull polygonAnnotationOptions;

Swift

@NSCopying var polygonAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    polylineAnnotationOptions

The options for polyline (PTExtendedAnnotTypePolyline) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull polylineAnnotationOptions;

Swift

@NSCopying var polylineAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    highlightAnnotationOptions

The options for highlight (PTExtendedAnnotTypeHighlight) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTTextMarkupAnnotationOptions *_Nonnull highlightAnnotationOptions;

Swift

@NSCopying var highlightAnnotationOptions: PTTextMarkupAnnotationOptions { get set }


                    
                    
                    underlineAnnotationOptions

The options for underline (PTExtendedAnnotTypeUnderline) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTTextMarkupAnnotationOptions *_Nonnull underlineAnnotationOptions;

Swift

@NSCopying var underlineAnnotationOptions: PTTextMarkupAnnotationOptions { get set }


                    
                    
                    squigglyAnnotationOptions

The options for squiggly (PTExtendedAnnotTypeSquiggly) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTTextMarkupAnnotationOptions *_Nonnull squigglyAnnotationOptions;

Swift

@NSCopying var squigglyAnnotationOptions: PTTextMarkupAnnotationOptions { get set }


                    
                    
                    strikeOutAnnotationOptions

The options for strikeout (PTExtendedAnnotTypeStrikeOut) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTTextMarkupAnnotationOptions *_Nonnull strikeOutAnnotationOptions;

Swift

@NSCopying var strikeOutAnnotationOptions: PTTextMarkupAnnotationOptions { get set }


                    
                    
                    stampAnnotationOptions

The options for rubber stamp (PTExtendedAnnotTypeStamp) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull stampAnnotationOptions;

Swift

@NSCopying var stampAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    caretAnnotationOptions

The options for caret (PTExtendedAnnotTypeCaret) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull caretAnnotationOptions;

Swift

@NSCopying var caretAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    inkAnnotationOptions

The options for ink (PTExtendedAnnotTypeInk) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull inkAnnotationOptions;

Swift

@NSCopying var inkAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    popupAnnotationOptions

The options for pop-up (PTExtendedAnnotTypePopup) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull popupAnnotationOptions;

Swift

@NSCopying var popupAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    fileAttachmentAnnotationOptions

The options for file attachment (PTExtendedAnnotTypeFileAttachment) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull fileAttachmentAnnotationOptions;

Swift

@NSCopying var fileAttachmentAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    soundAnnotationOptions

The options for sound (PTExtendedAnnotTypeSound) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull soundAnnotationOptions;

Swift

@NSCopying var soundAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    movieAnnotationOptions

The options for movie (PTExtendedAnnotTypeMovie) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull movieAnnotationOptions;

Swift

@NSCopying var movieAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    widgetAnnotationOptions

The options for widget (PTExtendedAnnotTypeWidget) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull widgetAnnotationOptions;

Swift

@NSCopying var widgetAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    screenAnnotationOptions

The options for Screen (PTExtendedAnnotTypeScreen) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull screenAnnotationOptions;

Swift

@NSCopying var screenAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    printerMarkAnnotationOptions

The options for printer’s mark (PTExtendedAnnotTypePrinterMark) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull printerMarkAnnotationOptions;

Swift

@NSCopying var printerMarkAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    trapNetAnnotationOptions

The options for trap network (PTExtendedAnnotTypeTrapNet) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull trapNetAnnotationOptions;

Swift

@NSCopying var trapNetAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    watermarkAnnotationOptions

The options for watermark (PTExtendedAnnotTypeWatermark) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull watermarkAnnotationOptions;

Swift

@NSCopying var watermarkAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    threeDimensionalAnnotationOptions

The options for 3D (PTExtendedAnnotType3D) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull threeDimensionalAnnotationOptions;

Swift

@NSCopying var threeDimensionalAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    redactAnnotationOptions

The options for redact (PTExtendedAnnotTypeRedact) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull redactAnnotationOptions;

Swift

@NSCopying var redactAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    projectionAnnotationOptions

The options for projection (PTExtendedAnnotTypeProjection) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull projectionAnnotationOptions;

Swift

@NSCopying var projectionAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    richMediaAnnotationOptions

The options for Rich Media (PTExtendedAnnotTypeRichMedia) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull richMediaAnnotationOptions;

Swift

@NSCopying var richMediaAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    arrowAnnotationOptions

The options for arrow (PTExtendedAnnotTypeArrow) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull arrowAnnotationOptions;

Swift

@NSCopying var arrowAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    signatureAnnotationOptions

The options for signature (PTExtendedAnnotTypeSignature) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTSignatureAnnotationOptions *_Nonnull signatureAnnotationOptions;

Swift

@NSCopying var signatureAnnotationOptions: PTSignatureAnnotationOptions { get set }


                    
                    
                    cloudyAnnotationOptions

The options for cloudy (PTExtendedAnnotTypeCloudy) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull cloudyAnnotationOptions;

Swift

@NSCopying var cloudyAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    imageStampAnnotationOptions

The options for image stamp (PTExtendedAnnotTypeImageStamp) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTImageStampAnnotationOptions *_Nonnull imageStampAnnotationOptions;

Swift

@NSCopying var imageStampAnnotationOptions: PTImageStampAnnotationOptions { get set }


                    
                    
                    rulerAnnotationOptions

The options for ruler (PTExtendedAnnotTypeRuler) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull rulerAnnotationOptions;

Swift

@NSCopying var rulerAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    perimeterAnnotationOptions

The options for perimeter (PTExtendedAnnotTypePerimeter) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull perimeterAnnotationOptions;

Swift

@NSCopying var perimeterAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    areaAnnotationOptions

The options for cloudy (PTExtendedAnnotTypeArea) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull areaAnnotationOptions;

Swift

@NSCopying var areaAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    pencilDrawingAnnotationOptions

The options for Apple Pencil drawing (PTExtendedAnnotTypePencilKit) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull pencilDrawingAnnotationOptions;

Swift

@NSCopying var pencilDrawingAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    freehandHighlightAnnotationOptions

The options for freehand highlight (PTExtendedAnnotTypeFreehandHighlight) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull freehandHighlightAnnotationOptions;

Swift

@NSCopying var freehandHighlightAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    calloutAnnotationOptions

The options for free text callout (PTExtendedAnnotTypeCallout) annotations.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    PTAnnotationOptions *_Nonnull calloutAnnotationOptions;

Swift

@NSCopying var calloutAnnotationOptions: PTAnnotationOptions { get set }


                    
                    
                    -annotationOptionsForAnnotType:

Returns the PTAnnotationOptions for the specified annotation type.

Declaration

Objective-C

- (nullable PTAnnotationOptions *)annotationOptionsForAnnotType:
    (PTExtendedAnnotType)annotType;

Swift

func annotationOptions(for annotType: PTExtendedAnnotType) -> PTAnnotationOptions?

Parameters


                                annotType

the annotation type

Return Value

the PTAnnotationOptions for the specified annotation type, or nil if not found.


                    
                    
                    -canCreateExtendedAnnotType:

Returns whether the specified annotation type can be created.

Declaration

Objective-C

- (BOOL)canCreateExtendedAnnotType:(PTExtendedAnnotType)annotType;

Swift

func canCreateExtendedAnnotType(_ annotType: PTExtendedAnnotType) -> Bool


                    
                    
                    -canEditExtendedAnnotType:

Returns whether the specified annotation type can be edited.

Declaration

Objective-C

- (BOOL)canEditExtendedAnnotType:(PTExtendedAnnotType)annotType;

Swift

func canEdit(_ annotType: PTExtendedAnnotType) -> Bool


                    
                    
                    pencilTool

The tool to use with Apple Pencil. The default pencil tool is PTFreehandCreate.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable) Class pencilTool;

Swift

var pencilTool: AnyClass? { get set }

Annotation permissions


                    
                    
                    -hasEditPermissionForAnnot:

Returns whether the specified annotation allows editing.

Declaration

Objective-C

- (BOOL)hasEditPermissionForAnnot:(nonnull PTAnnot *)annot;

Swift

func hasEditPermission(for annot: PTAnnot) -> Bool

annotationPermissionCheckEnabled
Whether the permissions of an PTAnnot, returned via -[PTAnnot GetFlag:], are checked when determining whether the annotation can be edited. The default value of this property is NO.
Declaration
Objective-C

@property (getter=isAnnotationPermissionCheckEnabled, assign, readwrite, nonatomic) BOOL annotationPermissionCheckEnabled;
Swift

var isAnnotationPermissionCheckEnabled: Bool { get set }
annotationAuthorCheckEnabled
Whether the author of an PTAnnot is checked against the current annotationAuthor when determining whether the annotation can be edited. The default value of this property is NO.
Declaration
Objective-C

@property (getter=isAnnotationAuthorCheckEnabled, assign, readwrite, nonatomic) BOOL annotationAuthorCheckEnabled;
Swift

var isAnnotationAuthorCheckEnabled: Bool { get set }

Interaction features


                    
                    
                    textSelectionEnabled

A boolean value that determines whether text selection is enabled.

Declaration

Objective-C

@property (getter=isTextSelectionEnabled, assign, readwrite, nonatomic)
    BOOL textSelectionEnabled;

Swift

var isTextSelectionEnabled: Bool { get set }


                    
                    
                    formFillingEnabled

A boolean value that determines whether form filling is enabled.

Declaration

Objective-C

@property (getter=isFormFillingEnabled, assign, readwrite, nonatomic)
    BOOL formFillingEnabled;

Swift

var isFormFillingEnabled: Bool { get set }


                    
                    
                    linkFollowingEnabled

A boolean value that determines whether link following is enabled.

Declaration

Objective-C

@property (getter=isLinkFollowingEnabled, assign, readwrite, nonatomic)
    BOOL linkFollowingEnabled;

Swift

var isLinkFollowingEnabled: Bool { get set }


                    
                    
                    eraserEnabled

A boolean value that determines whether the eraser tool is enabled.

Declaration

Objective-C

@property (getter=isEraserEnabled, assign, readwrite, nonatomic)
    BOOL eraserEnabled;

Swift

var isEraserEnabled: Bool { get set }


                    
                    
                    autoResizeFreeTextEnabled

A boolean value that determines whether free text annots should get automatically resized.

Declaration

Objective-C

@property (getter=isAutoResizeFreeTextEnabled, assign, readwrite, nonatomic)
    BOOL autoResizeFreeTextEnabled;

Swift

var isAutoResizeFreeTextEnabled: Bool { get set }


                    
                    
                    snapToDocumentGeometryEnabled

A boolean value that determines whether measurement annots should snap to document geometry.

Declaration

Objective-C

@property (getter=isSnapToDocumentGeometryEnabled, assign, readwrite, nonatomic)
    BOOL snapToDocumentGeometryEnabled;

Swift

var isSnapToDocumentGeometryEnabled: Bool { get set }


                    
                    
                    annotationsSnapToAspectRatio

A boolean value that determines whether annots should snap to their initial aspect ratio while being resized.

Declaration

Objective-C

@property (getter=isAnnotationsSnapToAspectRatioEnabled, assign, readwrite,
          nonatomic) BOOL annotationsSnapToAspectRatio;

Swift

var isAnnotationsSnapToAspectRatioEnabled: Bool { get set }

selectAnnotationAfterCreation
A boolean value that determines whether annotations are selected immediately after they are created. Default is true, or whatever value was last set by a PTToolsSettingsManager.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) BOOL selectAnnotationAfterCreation;
Swift

var selectAnnotationAfterCreation: Bool { get set }
freehandUsesPencilKit
A boolean value that determines whether PencilKit is used to create new free hand annotations. Availble only on iOS 13.1 and greater. Default is true, or whatever value was last set by a PTToolsSettingsManager.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) BOOL freehandUsesPencilKit;
Swift

var freehandUsesPencilKit: Bool { get set }

Asset locations


                    
                    
                    digitalCertificateLocation

A file path pointing to the digital certificate to use for digital signatures.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    NSURL *_Nonnull digitalCertificateLocation;

Swift

var digitalCertificateLocation: URL { get set }

Undo/redo


                    
                    
                    undoRedoManager

The undo-redo manager responsible for managing the undo/redo chain of the pdfViewCtrl.

Declaration

Objective-C

@property (readonly, strong, nonatomic)
    PTUndoRedoManager *_Nonnull undoRedoManager;

Swift

var undoRedoManager: PTUndoRedoManager { get }

Annotation events


                    
                    
                    -annotationAdded:onPageNumber:

Used to notify the tool manager that an annotation has been added.

Declaration

Objective-C

- (void)annotationAdded:(nonnull PTAnnot *)annotation
           onPageNumber:(int)pageNumber;

Swift

func annotationAdded(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The annotation that was added.
`pageNumber`	The page number of the PDF that the annotation was added to.


                    
                    
                    -willModifyAnnotation:onPageNumber:

Used to notify the tool manager that an annotation will be modified

Declaration

Objective-C

- (void)willModifyAnnotation:(nonnull PTAnnot *)annotation
                onPageNumber:(int)pageNumber;

Swift

func willModifyAnnotation(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The annotation will be modified.
`pageNumber`	The page number of the PDF that the annotation was modified on.


                    
                    
                    -annotationModified:onPageNumber:

Used to notify the tool manager that an annotation has been modified

Declaration

Objective-C

- (void)annotationModified:(nonnull PTAnnot *)annotation
              onPageNumber:(int)pageNumber;

Swift

func annotationModified(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The annotation that was modified.
`pageNumber`	The page number of the PDF that the annotation was modified on.


                    
                    
                    -willRemoveAnnotation:onPageNumber:

Used to notify the tool manager that an annotation will be removed

Declaration

Objective-C

- (void)willRemoveAnnotation:(nonnull PTAnnot *)annotation
                onPageNumber:(int)pageNumber;

Swift

func willRemoveAnnotation(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The annotation will be removed.
`pageNumber`	The page number of the PDF that the annotation was removed from.


                    
                    
                    -annotationRemoved:onPageNumber:

Used to notify the tool manager that an annotation has been removed.

Declaration

Objective-C

- (void)annotationRemoved:(nonnull PTAnnot *)annotation
             onPageNumber:(int)pageNumber;

Swift

func annotationRemoved(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The annotation that was removed.
`pageNumber`	The page number of the PDF that the annotation was removed from.


                    
                    
                    -formFieldDataModified:onPageNumber:

Used to notify the tool manager that the data of a form field has been modified.

Declaration

Objective-C

- (void)formFieldDataModified:(nonnull PTAnnot *)annotation
                 onPageNumber:(int)pageNumber;

Swift

func formFieldDataModified(_ annotation: PTAnnot, onPageNumber pageNumber: Int32)

Parameters

`annotation`	The form field annotation that has modified data.
`pageNumber`	The page number of the PDF that the form field annotation is on.

Page events


                    
                    
                    -pageAddedForPageNumber:

Used to notify the tool manager that a page has been added.

Declaration

Objective-C

- (void)pageAddedForPageNumber:(int)pageNumber;

Swift

func pageAdded(forPageNumber pageNumber: Int32)

Parameters


                                pageNumber

The page number of the page that was added.

-pageMovedFromPageNumber:toPageNumber:
Used to notify the tool manager that a page has been moved. *
- - parameter: oldPageNumber The old page number of the page.
- - parameter: newPageNumber The new page number of the page.
Declaration
Objective-C

- (void)pageMovedFromPageNumber:(int)oldPageNumber toPageNumber:(int)newPageNumber;
Swift

func pageMoved(fromPageNumber oldPageNumber: Int32, toPageNumber newPageNumber: Int32)


                    
                    
                    -pageRemovedForPageNumber:

Used to notify the tool manager that a page has been removed.

Declaration

Objective-C

- (void)pageRemovedForPageNumber:(int)pageNumber;

Swift

func pageRemoved(forPageNumber pageNumber: Int32)

Parameters


                                pageNumber

The page number of the page that was removed.