Class PTTool

Inheritance

System.Object

PTTool

PTAnnotEditTool

PTAnnotSelectTool

PTCreateToolBase

PTDigitalSignatureTool

PTFormFillTool

PTFreeTextCreate

PTPanTool

PTRichMediaTool

PTTextMarkupCreate

PTTextSelectTool

Implements

IPTNoteEditControllerDelegate

IPTOverridable

IPTToolSwitching

IPTPDFViewCtrlToolDelegate

ObjCRuntime.INativeObject

System.IDisposable

UIKit.IUIAdaptivePresentationControllerDelegate

UIKit.IUIGestureRecognizerDelegate

UIKit.IUIPopoverPresentationControllerDelegate

Namespace: pdftron.PDF.Tools

Assembly: Tools.dll

Syntax

public class PTTool : UIView, IPTNoteEditControllerDelegate, IPTOverridable, IPTToolSwitching, IPTPDFViewCtrlToolDelegate, INativeObject, IDisposable, IUIAdaptivePresentationControllerDelegate, IUIGestureRecognizerDelegate, IUIPopoverPresentationControllerDelegate

Constructors

PTTool(NSCoder)

Declaration

public PTTool(NSCoder coder)

Parameters

Type	Name	Description
Foundation.NSCoder	coder

PTTool(NSObjectFlag)

Declaration

protected PTTool(NSObjectFlag t)

Parameters

Type	Name	Description
Foundation.NSObjectFlag	t

PTTool(PTPDFViewCtrl)

Declaration

public PTTool(PTPDFViewCtrl in_pdfViewCtrl)

Parameters

Type	Name	Description
PTPDFViewCtrl	in_pdfViewCtrl

PTTool(IntPtr)

Declaration

protected PTTool(IntPtr handle)

Parameters

Type	Name	Description
System.IntPtr	handle

Properties

AllowScrolling

Declaration

public virtual bool AllowScrolling { get; }

Property Value

Type	Description
System.Boolean

AllowZoom

Declaration

public virtual bool AllowZoom { get; set; }

Property Value

Type	Description
System.Boolean

AnnotationAuthor

Declaration

public virtual string AnnotationAuthor { get; set; }

Property Value

Type	Description
System.String

AnnotationPageNumber

Declaration

public virtual uint AnnotationPageNumber { get; set; }

Property Value

Type	Description
System.UInt32

AnnotClass

Declaration

public virtual Class AnnotClass { get; }

Property Value

Type	Description
ObjCRuntime.Class

AnnotType

Declaration

public virtual PTExtendedAnnotType AnnotType { get; }

Property Value

Type	Description
PTExtendedAnnotType

Appearance

Declaration

public static PTTool.PTToolAppearance Appearance { get; }

Property Value

Type	Description
PTTool.PTToolAppearance

BackToPanToolAfterUse

Declaration

public virtual bool BackToPanToolAfterUse { get; set; }

Property Value

Type	Description
System.Boolean

CanEditStyle

Declaration

public virtual bool CanEditStyle { get; }

Property Value

Type	Description
System.Boolean

ClassAnnotType

Declaration

public static PTExtendedAnnotType ClassAnnotType { get; }

Property Value

Type	Description
PTExtendedAnnotType

ClassHandle

Declaration

public override IntPtr ClassHandle { get; }

Property Value

Type	Description
System.IntPtr

CreatesAnnotation

Declaration

public virtual bool CreatesAnnotation { get; }

Property Value

Type	Description
System.Boolean

CreatesAnnotation2

Declaration

public static bool CreatesAnnotation2 { get; }

Property Value

Type	Description
System.Boolean

CurrentAnnotation

Declaration

public virtual PTAnnot CurrentAnnotation { get; set; }

Property Value

Type	Description
PTAnnot

DefaultClass

Declaration

public virtual Class DefaultClass { get; set; }

Property Value

Type	Description
ObjCRuntime.Class

LongPressPoint

Declaration

public virtual CGPoint LongPressPoint { get; set; }

Property Value

Type	Description
CoreGraphics.CGPoint

NewTool

Declaration

public virtual UIView NewTool { get; }

Property Value

Type	Description
UIKit.UIView

NextToolType

Declaration

public virtual Class NextToolType { get; set; }

Property Value

Type	Description
ObjCRuntime.Class

PageIndicatorIsVisible

Declaration

public virtual bool PageIndicatorIsVisible { get; set; }

Property Value

Type	Description
System.Boolean

PdfViewCtrl

Declaration

public virtual PTPDFViewCtrl PdfViewCtrl { get; }

Property Value

Type	Description
PTPDFViewCtrl

PreviousToolType

Declaration

public virtual Class PreviousToolType { get; set; }

Property Value

Type	Description
ObjCRuntime.Class

TextMarkupAdobeHack

Declaration

public virtual bool TextMarkupAdobeHack { get; set; }

Property Value

Type	Description
System.Boolean

ToolManager

Declaration

public virtual PTToolManager ToolManager { get; set; }

Property Value

Type	Description
PTToolManager

ViewController

Declaration

public virtual UIViewController ViewController { get; }

Property Value

Type	Description
UIKit.UIViewController

Methods

AnnotationAdded(PTAnnot, nuint)

Declaration

public virtual void AnnotationAdded(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

AnnotationModified(PTAnnot, nuint)

Declaration

public virtual void AnnotationModified(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

AnnotationRemoved(PTAnnot, nuint)

Declaration

public virtual void AnnotationRemoved(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

AppearanceWhenContainedIn(Type[])

Declaration

public static PTTool.PTToolAppearance AppearanceWhenContainedIn(params Type[] containers)

Parameters

Type	Name	Description
System.Type[]	containers

Returns

Type	Description
PTTool.PTToolAppearance

CGRectScreen2PDFRectPage(CGRect, Int32)

Declaration

public virtual PTPDFRect CGRectScreen2PDFRectPage(CGRect screenRect, int pageNumber)

Parameters

Type	Name	Description
CoreGraphics.CGRect	screenRect
System.Int32	pageNumber

Returns

Type	Description
PTPDFRect

ConvertPagePtToScreenPt(CGPoint, Int32)

Declaration

public virtual CGPoint ConvertPagePtToScreenPt(CGPoint pagePoint, int pageNumber)

Parameters

Type	Name	Description
CoreGraphics.CGPoint	pagePoint
System.Int32	pageNumber

Returns

Type	Description
CoreGraphics.CGPoint

ConvertPagePtToScreenPtX(out nfloat, out nfloat, Int32)

Declaration

public virtual void ConvertPagePtToScreenPtX(out nfloat x, out nfloat y, int pageNumber)

Parameters

Type	Name	Description
System.nfloat	x
System.nfloat	y
System.Int32	pageNumber

ConvertScreenPtToPagePt(CGPoint, Int32)

Declaration

public virtual CGPoint ConvertScreenPtToPagePt(CGPoint screenPoint, int pageNumber)

Parameters

Type	Name	Description
CoreGraphics.CGPoint	screenPoint
System.Int32	pageNumber

Returns

Type	Description
CoreGraphics.CGPoint

ConvertScreenPtToPagePtX(out nfloat, out nfloat, Int32)

Declaration

public virtual void ConvertScreenPtToPagePtX(out nfloat x, out nfloat y, int pageNumber)

Parameters

Type	Name	Description
System.nfloat	x
System.nfloat	y
System.Int32	pageNumber

DeleteSelectedAnnotation()

Declaration

public virtual void DeleteSelectedAnnotation()

DidSelectAnnotation(PTAnnot, nuint)

Declaration

public virtual void DidSelectAnnotation(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

EditSelectedAnnotationNote()

Declaration

public virtual void EditSelectedAnnotationNote()

ExecuteAction(PTActionParameter)

Declaration

public virtual void ExecuteAction(PTActionParameter action_param)

Parameters

Type	Name	Description
PTActionParameter	action_param

FormFieldDataModified(PTAnnot, nuint)

Declaration

public virtual void FormFieldDataModified(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

GetAppearance(UITraitCollection)

Declaration

public static PTTool.PTToolAppearance GetAppearance(UITraitCollection traits)

Parameters

Type	Name	Description
UIKit.UITraitCollection	traits

Returns

Type	Description
PTTool.PTToolAppearance

GetAppearance(UITraitCollection, Type[])

Declaration

public static PTTool.PTToolAppearance GetAppearance(UITraitCollection traits, params Type[] containers)

Parameters

Type	Name	Description
UIKit.UITraitCollection	traits
System.Type[]	containers

Returns

Type	Description
PTTool.PTToolAppearance

GetAppearance<T>()

Declaration

public static PTTool.PTToolAppearance GetAppearance<T>()
    where T : PTTool

Returns

Type	Description
PTTool.PTToolAppearance

Type Parameters

Name	Description
T

GetAppearance<T>(UITraitCollection)

Declaration

public static PTTool.PTToolAppearance GetAppearance<T>(UITraitCollection traits)
    where T : PTTool

Parameters

Type	Name	Description
UIKit.UITraitCollection	traits

Returns

Type	Description
PTTool.PTToolAppearance

Type Parameters

Name	Description
T

GetAppearance<T>(UITraitCollection, Type[])

Declaration

public static PTTool.PTToolAppearance GetAppearance<T>(UITraitCollection traits, params Type[] containers)
    where T : PTTool

Parameters

Type	Name	Description
UIKit.UITraitCollection	traits
System.Type[]	containers

Returns

Type	Description
PTTool.PTToolAppearance

Type Parameters

Name	Description
T

GetRectUnion(PTPDFRect, PTPDFRect)

Declaration

public static PTPDFRect GetRectUnion(PTPDFRect rect1, PTPDFRect rect2)

Parameters

Type	Name	Description
PTPDFRect	rect1
PTPDFRect	rect2

Returns

Type	Description
PTPDFRect

HandleFileAttachment(PTFileAttachment, nuint)

Declaration

public virtual void HandleFileAttachment(PTFileAttachment fileAttachment, nuint pageNumber)

Parameters

Type	Name	Description
PTFileAttachment	fileAttachment
System.nuint	pageNumber

HideMenu()

Declaration

public virtual void HideMenu()

KeepToolAppearanceOnScreen()

Declaration

public virtual void KeepToolAppearanceOnScreen()

KeepToolAppearanceOnScreenWithImageView(UIImageView)

Declaration

public virtual void KeepToolAppearanceOnScreenWithImageView(UIImageView imageView)

Parameters

Type	Name	Description
UIKit.UIImageView	imageView

NoteEditControllerCancelButtonPressed(PTNoteEditController, Boolean)

Declaration

public virtual void NoteEditControllerCancelButtonPressed(PTNoteEditController noteEditController, bool showSelectionMenu)

Parameters

Type	Name	Description
PTNoteEditController	noteEditController
System.Boolean	showSelectionMenu

NoteEditControllerDeleteSelectedAnnotation(PTNoteEditController)

Declaration

public virtual void NoteEditControllerDeleteSelectedAnnotation(PTNoteEditController noteEditController)

Parameters

Type	Name	Description
PTNoteEditController	noteEditController

NoteEditControllerSaveNewNote(PTNoteEditController, String)

Declaration

public virtual void NoteEditControllerSaveNewNote(PTNoteEditController noteEditController, string str)

Parameters

Type	Name	Description
PTNoteEditController	noteEditController
System.String	str

OnSwitchToolEvent(NSObject)

Declaration

public virtual bool OnSwitchToolEvent(NSObject userData)

Parameters

Type	Name	Description
Foundation.NSObject	userData

Returns

Type	Description
System.Boolean

PageBoxInScreenPtsForPageNumber(Int32)

Declaration

public virtual PTPDFRect PageBoxInScreenPtsForPageNumber(int pageNumber)

Parameters

Type	Name	Description
System.Int32	pageNumber

Returns

Type	Description
PTPDFRect

PDFRectPage2CGRectScreen(PTPDFRect, Int32)

Declaration

public virtual CGRect PDFRectPage2CGRectScreen(PTPDFRect r, int pageNumber)

Parameters

Type	Name	Description
PTPDFRect	r
System.Int32	pageNumber

Returns

Type	Description
CoreGraphics.CGRect

PDFRectScreen2CGRectScreen(PTPDFRect, Int32)

Declaration

public virtual CGRect PDFRectScreen2CGRectScreen(PTPDFRect r, int pageNumber)

Parameters

Type	Name	Description
PTPDFRect	r
System.Int32	pageNumber

Returns

Type	Description
CoreGraphics.CGRect

RemoveAppearanceViews()

Declaration

public virtual void RemoveAppearanceViews()

ShouldHandleLinkAnnotation(PTAnnot, PTLinkInfo, nuint)

Declaration

public virtual bool ShouldHandleLinkAnnotation(PTAnnot annotation, PTLinkInfo linkInfo, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
PTLinkInfo	linkInfo
System.nuint	pageNumber

Returns

Type	Description
System.Boolean

ShouldInteractWithForm(PTAnnot, nuint)

Declaration

public virtual bool ShouldInteractWithForm(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

Returns

Type	Description
System.Boolean

ShouldSelectAnnotation(PTAnnot, nuint)

Declaration

public virtual bool ShouldSelectAnnotation(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

Returns

Type	Description
System.Boolean

ShouldShowMenu(UIMenuController, PTAnnot, nuint)

Declaration

public virtual bool ShouldShowMenu(UIMenuController menuController, PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
UIKit.UIMenuController	menuController
PTAnnot	annotation
System.nuint	pageNumber

Returns

Type	Description
System.Boolean

ShowSelectionMenu(CGRect)

Declaration

public virtual void ShowSelectionMenu(CGRect targetRect)

Parameters

Type	Name	Description
CoreGraphics.CGRect	targetRect

ShowSelectionMenu(CGRect, Boolean)

Declaration

public virtual void ShowSelectionMenu(CGRect targetRect, bool animated)

Parameters

Type	Name	Description
CoreGraphics.CGRect	targetRect
System.Boolean	animated

WillModifyAnnotation(PTAnnot, nuint)

Declaration

public virtual void WillModifyAnnotation(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

WillRemoveAnnotation(PTAnnot, nuint)

Declaration

public virtual void WillRemoveAnnotation(PTAnnot annotation, nuint pageNumber)

Parameters

Type	Name	Description
PTAnnot	annotation
System.nuint	pageNumber

Implements

IPTNoteEditControllerDelegate

IPTOverridable

IPTToolSwitching

IPTPDFViewCtrlToolDelegate

ObjCRuntime.INativeObject

System.IDisposable

UIKit.IUIAdaptivePresentationControllerDelegate

UIKit.IUIGestureRecognizerDelegate

UIKit.IUIPopoverPresentationControllerDelegate