PDF Interaction Tools Reference


                    
                    
                    PTAnnotEditTool

The PTAnnotEditTool is used to change the properties, position and size of annotations. It also handles link annotations.

Declaration

Objective-C


@interface PTAnnotEditTool
    : PTTool <PTSelectionRectViewDelegate,
              UIPopoverPresentationControllerDelegate, UITextViewDelegate,
              PTAnnotStyleViewControllerDelegate>

Swift

class PTAnnotEditTool : PTTool, PTSelectionRectViewDelegate, UIPopoverPresentationControllerDelegate, UITextViewDelegate, PTAnnotStyleViewControllerDelegate


                    
                    
                    PTAnnotSelectTool

The PTAnnotSelectTool is used to select multiple annotations.

Declaration

Objective-C


@interface PTAnnotSelectTool : PTTool

Swift

class PTAnnotSelectTool : PTTool


                    
                    
                    PTArrowCreate

Creates arrow annotations.

Declaration

Objective-C


@interface PTArrowCreate : PTCreateToolBase

Swift

class PTArrowCreate : PTCreateToolBase


                    
                    
                    PTCalloutCreate

Creates free text callout (PTExtendedAnnotTypeCallout) annotations.

Declaration

Objective-C


@interface PTCalloutCreate : PTFreeTextCreate

Swift

class PTCalloutCreate : PTFreeTextCreate


                    
                    
                    PTCloudCreate

Creates cloudy annotations.

Declaration

Objective-C


@interface PTCloudCreate : PTPolygonCreate

Swift

class PTCloudCreate : PTPolygonCreate


                    
                    
                    PTDigitalSignatureTool

Handles creation of signatures and digitally signing documents.

Declaration

Objective-C


@interface PTDigitalSignatureTool
    : PTTool <PTDigSigViewControllerDelegate,
              PTFloatingSigViewControllerDelegate, PTSignaturesManagerDelegate,
              UIAdaptivePresentationControllerDelegate>

Swift

class PTDigitalSignatureTool : PTTool, PTDigSigViewControllerDelegate, PTFloatingSigViewControllerDelegate, PTSignaturesManagerDelegate, UIAdaptivePresentationControllerDelegate


                    
                    
                    PTEllipseCreate

Creates ellipse annotations.

Declaration

Objective-C


@interface PTEllipseCreate : PTCreateToolBase

Swift

class PTEllipseCreate : PTCreateToolBase


                    
                    
                    PTEraser

Erases points from FreeHand (ink) annotations.

Declaration

Objective-C


@interface PTEraser : PTCreateToolBase

Swift

class PTEraser : PTCreateToolBase


                    
                    
                    PTFormFillTool

This tool is used to fill PDF forms (AcroForms). This includes text boxes, check boxes, radio buttons, drop downs, and more.

Signatures fields are handled by the PTDigitalSignatureTool.

Declaration

Objective-C


@interface PTFormFillTool : PTTool

Swift

class PTFormFillTool : PTTool


                    
                    
                    PTFreeHandCreate

Creates FreeHand (Ink) annotations.

Declaration

Objective-C


@interface PTFreeHandCreate : PTCreateToolBase

Swift

class PTFreeHandCreate : PTCreateToolBase


                    
                    
                    PTFreeHandHighlightCreate

Creates Freehand (Ink) annotations with a multiply blend mode applied.

Declaration

Objective-C


@interface PTFreeHandHighlightCreate : PTFreeHandCreate

Swift

class PTFreeHandHighlightCreate : PTFreeHandCreate


                    
                    
                    PTFreeTextCreate

Creates a free text annotation.

Declaration

Objective-C


@interface PTFreeTextCreate : PTTool <UITextViewDelegate>

Swift

class PTFreeTextCreate : PTTool, UITextViewDelegate


                    
                    
                    PTLineCreate

Creates line annotations.

Declaration

Objective-C


@interface PTLineCreate : PTCreateToolBase

Swift

class PTLineCreate : PTCreateToolBase


                    
                    
                    PTPanTool

A non-annotating tool that is used to navigate the document. When the user taps or long presses on the document, the pan tool will check the content of the document for annotaitons and text, and if found, pass the event to the appropriate tool. When long pressing an emtpy section of the document, the PTPanTool gives the option to switch to a selection of annotation creation tools.

Declaration

Objective-C


@interface PTPanTool : PTTool

Swift

class PTPanTool : PTTool


                    
                    
                    PTPencilDrawingCreate

Creates Apple Pencil drawing annotations.

Declaration

Objective-C


@interface PTPencilDrawingCreate : PTCreateToolBase

Swift

class PTPencilDrawingCreate : PTCreateToolBase


                    
                    
                    PTPolygonCreate

Creates polygon annotations.

Declaration

Objective-C


@interface PTPolygonCreate : PTPolylineCreate

Swift

class PTPolygonCreate : PTPolylineCreate


                    
                    
                    PTPolylineCreate

Creates polyline annotations.

Declaration

Objective-C


@interface PTPolylineCreate : PTCreateToolBase

Swift

class PTPolylineCreate : PTCreateToolBase


                    
                    
                    PTPolylineEditTool

The PTPolylineEditTool is used to edit polyline, polygon, and cloudy annotations.

Declaration

Objective-C


@interface PTPolylineEditTool : PTAnnotEditTool

Swift

class PTPolylineEditTool : PTAnnotEditTool


                    
                    
                    PTRectangleCreate

Creates rectangle annotations.

Declaration

Objective-C


@interface PTRectangleCreate : PTCreateToolBase

Swift

class PTRectangleCreate : PTCreateToolBase


                    
                    
                    PTRichMediaTool

Plays movies that are embedded in PDF files.

Declaration

Objective-C


@interface PTRichMediaTool : PTTool

Swift

class PTRichMediaTool : PTTool


                    
                    
                    PTRubberStampCreate

Creates stamp annotations.

Declaration

Objective-C


@interface PTRubberStampCreate : PTCreateToolBase

Swift

class PTRubberStampCreate : PTCreateToolBase


                    
                    
                    PTStickyNoteCreate

Creates sticky note annotations.

Declaration

Objective-C


@interface PTStickyNoteCreate : PTCreateToolBase

Swift

class PTStickyNoteCreate : PTCreateToolBase


                    
                    
                    PTTextHighlightCreate

Creates a text highlight annotation.

Declaration

Objective-C


@interface PTTextHighlightCreate : PTTextMarkupCreate

Swift

class PTTextHighlightCreate : PTTextMarkupCreate


                    
                    
                    PTTextSelectTool

Tool for selecting text.

Declaration

Objective-C


@interface PTTextSelectTool : PTTool

Swift

class PTTextSelectTool : PTTool


                    
                    
                    PTTextSquigglyCreate

Creates a text squiggly annotation.

Declaration

Objective-C


@interface PTTextSquigglyCreate : PTTextMarkupCreate

Swift

class PTTextSquigglyCreate : PTTextMarkupCreate


                    
                    
                    PTTextStrikeoutCreate

Creates a text strikeout annotation.

Declaration

Objective-C


@interface PTTextStrikeoutCreate : PTTextMarkupCreate

Swift

class PTTextStrikeoutCreate : PTTextMarkupCreate


                    
                    
                    PTTextUnderlineCreate

Creates a text underline annotation.

Declaration

Objective-C


@interface PTTextUnderlineCreate : PTTextMarkupCreate

Swift

class PTTextUnderlineCreate : PTTextMarkupCreate