Show / Hide Table of Contents

Class PTAnnotationManager

Inheritance
System.Object
PTAnnotationManager
Implements
IPTOverridable
ObjCRuntime.INativeObject
System.IDisposable
Namespace: pdftron.PDF.Utils
Assembly: Tools.dll
Syntax
public class PTAnnotationManager : NSObject, IPTOverridable, INativeObject, IDisposable

Constructors

PTAnnotationManager(NSObjectFlag)

Declaration
protected PTAnnotationManager(NSObjectFlag t)
Parameters
Type Name Description
Foundation.NSObjectFlag t

PTAnnotationManager(PTPDFViewCtrl)

Declaration
public PTAnnotationManager(PTPDFViewCtrl pdfViewCtrl)
Parameters
Type Name Description
PTPDFViewCtrl pdfViewCtrl

PTAnnotationManager(PTToolManager)

Declaration
public PTAnnotationManager(PTToolManager toolManager)
Parameters
Type Name Description
PTToolManager toolManager

PTAnnotationManager(IntPtr)

Declaration
protected PTAnnotationManager(IntPtr handle)
Parameters
Type Name Description
System.IntPtr handle

Properties

AnnotationAuthorIdentifier

Declaration
public virtual string AnnotationAuthorIdentifier { get; set; }
Property Value
Type Description
System.String

AnnotationEditMode

Declaration
public virtual PTAnnotationEditMode AnnotationEditMode { get; set; }
Property Value
Type Description
PTAnnotationEditMode

AnnotationsLoaded

Declaration
public virtual bool AnnotationsLoaded { get; }
Property Value
Type Description
System.Boolean

ClassHandle

Declaration
public override IntPtr ClassHandle { get; }
Property Value
Type Description
System.IntPtr

DocumentModel

Declaration
public virtual PTDocumentModel DocumentModel { get; }
Property Value
Type Description
PTDocumentModel

DocumentModelLoaded

Declaration
public virtual bool DocumentModelLoaded { get; }
Property Value
Type Description
System.Boolean

LoadingAnnotations

Declaration
public virtual bool LoadingAnnotations { get; }
Property Value
Type Description
System.Boolean

LoadingDocumentModel

Declaration
public virtual bool LoadingDocumentModel { get; }
Property Value
Type Description
System.Boolean

PdfViewCtrl

Declaration
public virtual PTPDFViewCtrl PdfViewCtrl { get; set; }
Property Value
Type Description
PTPDFViewCtrl

ToolManager

Declaration
public virtual PTToolManager ToolManager { get; set; }
Property Value
Type Description
PTToolManager

UndoRedoManager

Declaration
public virtual PTUndoRedoManager UndoRedoManager { get; set; }
Property Value
Type Description
PTUndoRedoManager

Methods

AnnotationModelForAnnotation(PTAnnot, Int32, Action<PTAnnotationModel, NSError>)

Declaration
public virtual void AnnotationModelForAnnotation(PTAnnot annotation, int pageNumber, Action<PTAnnotationModel, NSError> completionHandler)
Parameters
Type Name Description
PTAnnot annotation
System.Int32 pageNumber
System.Action<PTAnnotationModel, Foundation.NSError> completionHandler

CanEditAnnotationModel(PTAnnotationModel)

Declaration
public virtual bool CanEditAnnotationModel(PTAnnotationModel annotationModel)
Parameters
Type Name Description
PTAnnotationModel annotationModel
Returns
Type Description
System.Boolean

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

FindAnnotationWithIdentifier(String, Int32, out NSError)

Declaration
public virtual PTAnnot FindAnnotationWithIdentifier(string annotationIdentifier, int pageNumber, out NSError error)
Parameters
Type Name Description
System.String annotationIdentifier
System.Int32 pageNumber
Foundation.NSError error
Returns
Type Description
PTAnnot

GenerateIdentifierForAnnotation(PTAnnot)

Declaration
public virtual void GenerateIdentifierForAnnotation(PTAnnot annotation)
Parameters
Type Name Description
PTAnnot annotation

GetAuthorName(String, out NSError)

Declaration
public virtual string GetAuthorName(string authorIdentifier, out NSError error)
Parameters
Type Name Description
System.String authorIdentifier
Foundation.NSError error
Returns
Type Description
System.String

IsAnnotation(PTAnnot, PTSDFDoc, String)

Declaration
public virtual bool IsAnnotation(PTAnnot annotation, PTSDFDoc document, string otherAnnotationAuthorIdentifier)
Parameters
Type Name Description
PTAnnot annotation
PTSDFDoc document
System.String otherAnnotationAuthorIdentifier
Returns
Type Description
System.Boolean

IsAnnotation(PTAnnot, String, String)

Declaration
public virtual bool IsAnnotation(PTAnnot annotation, string annotationAuthorIdentifier, string otherAnnotationAuthorIdentifier)
Parameters
Type Name Description
PTAnnot annotation
System.String annotationAuthorIdentifier
System.String otherAnnotationAuthorIdentifier
Returns
Type Description
System.Boolean

IsAnnotationWithAuthorIdentifier(String, String)

Declaration
public virtual bool IsAnnotationWithAuthorIdentifier(string annotationAuthorIdentifier, string otherAnnotationAuthorIdentifier)
Parameters
Type Name Description
System.String annotationAuthorIdentifier
System.String otherAnnotationAuthorIdentifier
Returns
Type Description
System.Boolean

LoadAnnotationModels()

Declaration
public virtual void LoadAnnotationModels()

LoadDocumentModel()

Declaration
public virtual void LoadDocumentModel()

LoadDocumentModelWithCompletionHandler(Action<PTDocumentModel, NSError>)

Declaration
public virtual void LoadDocumentModelWithCompletionHandler(Action<PTDocumentModel, NSError> completion)
Parameters
Type Name Description
System.Action<PTDocumentModel, Foundation.NSError> completion

RemoveAllAnnotationsOnPageNumber(Int32, out NSError)

Declaration
public virtual bool RemoveAllAnnotationsOnPageNumber(int pageNumber, out NSError error)
Parameters
Type Name Description
System.Int32 pageNumber
Foundation.NSError error
Returns
Type Description
System.Boolean

RemoveAllAnnotationsWithError(out NSError)

Declaration
public virtual bool RemoveAllAnnotationsWithError(out NSError error)
Parameters
Type Name Description
Foundation.NSError error
Returns
Type Description
System.Boolean

SetAuthorForAnnotation(PTAnnot, String)

Declaration
public virtual void SetAuthorForAnnotation(PTAnnot annotation, string authorIdentifier)
Parameters
Type Name Description
PTAnnot annotation
System.String authorIdentifier

SetAuthorName(String, String, Action<Boolean, NSError>)

Declaration
public virtual void SetAuthorName(string authorName, string authorIdentifier, Action<bool, NSError> completion)
Parameters
Type Name Description
System.String authorName
System.String authorIdentifier
System.Action<System.Boolean, Foundation.NSError> completion

UpdateAnnotationsWithXFDFCommand(String, out NSError)

Declaration
public virtual bool UpdateAnnotationsWithXFDFCommand(string xfdfCommand, out NSError error)
Parameters
Type Name Description
System.String xfdfCommand
Foundation.NSError error
Returns
Type Description
System.Boolean

UpdateAnnotationsWithXFDFString(String, out NSError)

Declaration
public virtual bool UpdateAnnotationsWithXFDFString(string xfdfString, out NSError error)
Parameters
Type Name Description
System.String xfdfString
Foundation.NSError error
Returns
Type Description
System.Boolean

UpdateModificationDateForAnnotation(PTAnnot)

Declaration
public virtual void UpdateModificationDateForAnnotation(PTAnnot annotation)
Parameters
Type Name Description
PTAnnot annotation

Implements

IPTOverridable
ObjCRuntime.INativeObject
System.IDisposable

Extension Methods

PTAnnotationManager_AnnotationEvents.AnnotationAdded(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.AnnotationModified(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.AnnotationRemoved(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.AnnotationsAdded(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.AnnotationsDidChangeWithChanges(PTAnnotationManager, PTPDFAnnotationChange[])
PTAnnotationManager_AnnotationEvents.AnnotationsModified(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.AnnotationsRemoved(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.AnnotationsWillChangeWithChanges(PTAnnotationManager, PTPDFAnnotationChange[])
PTAnnotationManager_AnnotationEvents.DidFlattenAnnotations(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.DidUpdateAnnotationsWithXFDFCommand(PTAnnotationManager, String)
PTAnnotationManager_AnnotationEvents.DidUpdateAnnotationsWithXFDFString(PTAnnotationManager, String)
PTAnnotationManager_AnnotationEvents.FormFieldDataModifiedForAnnotation(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.WillFlattenAnnotations(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.WillModifyAnnotation(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.WillModifyAnnotations(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.WillRemoveAnnotation(PTAnnotationManager, PTAnnot, Int32)
PTAnnotationManager_AnnotationEvents.WillRemoveAnnotations(PTAnnotationManager, PTAnnot[], Int32)
PTAnnotationManager_AnnotationEvents.WillUpdateAnnotationsWithXFDFCommand(PTAnnotationManager, String)
PTAnnotationManager_AnnotationEvents.WillUpdateAnnotationsWithXFDFString(PTAnnotationManager, String)
PTAnnotationManager_AnnotationOperations.FlattenAnnotation(PTAnnotationManager, PTAnnot, Int32, out NSError)
PTAnnotationManager_AnnotationOperations.FlattenAnnotations(PTAnnotationManager, PTAnnot[], Int32, out NSError)
PTAnnotationManager_AnnotationOperations.ModifyAnnotation(PTAnnotationManager, PTAnnot, Int32, Action<PTAnnot, Int32>)
PTAnnotationManager_AnnotationOperations.ModifyAnnotations(PTAnnotationManager, PTAnnot[], Int32, Action<NSArray<PTAnnot>, Int32>)
PTAnnotationManager_AnnotationOperations.RemoveAnnotation(PTAnnotationManager, PTAnnot, Int32, out NSError)
PTAnnotationManager_AnnotationOperations.RemoveAnnotations(PTAnnotationManager, PTAnnot[], Int32, out NSError)
Back to top Generated by DocFX