Show / Hide Table of Contents

Class AnnotUtils

Inheritance
System.Object
AnnotUtils
Namespace: pdftron.PDF.Tools.Utils
Assembly: PDFViewCtrlTools.dll
Syntax
public class AnnotUtils : Object

Constructors

AnnotUtils()

Declaration
public AnnotUtils()

AnnotUtils(IntPtr, JniHandleOwnership)

Declaration
protected AnnotUtils(IntPtr javaReference, JniHandleOwnership transfer)
Parameters
Type Name Description
System.IntPtr javaReference
Android.Runtime.JniHandleOwnership transfer

Fields

KeyInkList

Declaration
public const string KeyInkList = "InkList"
Field Value
Type Description
System.String

XfdfAdd

Declaration
public const string XfdfAdd = "add"
Field Value
Type Description
System.String

XfdfDelete

Declaration
public const string XfdfDelete = "delete"
Field Value
Type Description
System.String

XfdfModify

Declaration
public const string XfdfModify = "modify"
Field Value
Type Description
System.String

Properties

JniPeerMembers

Declaration
public override JniPeerMembers JniPeerMembers { get; }
Property Value
Type Description
Java.Interop.JniPeerMembers

KeyAnnotRotation

Declaration
public static string KeyAnnotRotation { get; set; }
Property Value
Type Description
System.String

KEYFreeTextDate

Declaration
public static string KEYFreeTextDate { get; set; }
Property Value
Type Description
System.String

KEYFreeTextFill

Declaration
public static string KEYFreeTextFill { get; set; }
Property Value
Type Description
System.String

KEYInReplyTo

Declaration
public static string KEYInReplyTo { get; set; }
Property Value
Type Description
System.String

KeyNm

Declaration
public static string KeyNm { get; set; }
Property Value
Type Description
System.String

KEYRawRichContent

Declaration
public static string KEYRawRichContent { get; set; }
Property Value
Type Description
System.String

KEYReplyTo

Declaration
public static string KEYReplyTo { get; set; }
Property Value
Type Description
System.String

KEYRichContent

Declaration
public static string KEYRichContent { get; set; }
Property Value
Type Description
System.String

KeyState

Declaration
public static string KeyState { get; set; }
Property Value
Type Description
System.String

KeyStateAccepted

Declaration
public static string KeyStateAccepted { get; set; }
Property Value
Type Description
System.String

KeyStateCancelled

Declaration
public static string KeyStateCancelled { get; set; }
Property Value
Type Description
System.String

KeyStateCompleted

Declaration
public static string KeyStateCompleted { get; set; }
Property Value
Type Description
System.String

KeyStateModel

Declaration
public static string KeyStateModel { get; set; }
Property Value
Type Description
System.String

KeyStateModelMarked

Declaration
public static string KeyStateModelMarked { get; set; }
Property Value
Type Description
System.String

KeyStateModelReview

Declaration
public static string KeyStateModelReview { get; set; }
Property Value
Type Description
System.String

KeyStateNone

Declaration
public static string KeyStateNone { get; set; }
Property Value
Type Description
System.String

KeyStateRejected

Declaration
public static string KeyStateRejected { get; set; }
Property Value
Type Description
System.String

KeyUnrotatedBbox

Declaration
public static string KeyUnrotatedBbox { get; set; }
Property Value
Type Description
System.String

KEYWidgetAuthor

Declaration
public static string KEYWidgetAuthor { get; set; }
Property Value
Type Description
System.String

ThresholdClass

Declaration
protected override IntPtr ThresholdClass { get; }
Property Value
Type Description
System.IntPtr

ThresholdType

Declaration
protected override Type ThresholdType { get; }
Property Value
Type Description
System.Type

VALUEGroup

Declaration
public static string VALUEGroup { get; set; }
Property Value
Type Description
System.String

Methods

CanUseBitmapAppearance(Annot)

Declaration
public static bool CanUseBitmapAppearance(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

CompareCreationDate(Annot, Annot)

Declaration
public static int CompareCreationDate(Annot thisObj, Annot thatObj)
Parameters
Type Name Description
pdftronprivate.PDF.Annot thisObj
pdftronprivate.PDF.Annot thatObj
Returns
Type Description
System.Int32

CompareDate(Annot, Annot)

Declaration
public static int CompareDate(Annot thisObj, Annot thatObj)
Parameters
Type Name Description
pdftronprivate.PDF.Annot thisObj
pdftronprivate.PDF.Annot thatObj
Returns
Type Description
System.Int32

ComputeAnnotInbox(PDFViewCtrl, Annot, Int32)

Declaration
public static Rect ComputeAnnotInbox(PDFViewCtrl pdfViewCtrl, Annot annot, int pg)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pg
Returns
Type Description
pdftronprivate.PDF.Rect

CreateAnnotationGroup(PDFViewCtrl, Annot, IList<Annot>)

Declaration
public static void CreateAnnotationGroup(PDFViewCtrl pdfViewCtrl, Annot primary, IList<Annot> allInGroup)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot primary
System.Collections.Generic.IList<pdftronprivate.PDF.Annot> allInGroup

CreateAnnotationReply(String, Int32, PDFViewCtrl, String, String)

Declaration
public static Annot CreateAnnotationReply(string parentAnnotId, int pageNum, PDFViewCtrl pdfViewCtrl, string authorId, string contents)
Parameters
Type Name Description
System.String parentAnnotId
System.Int32 pageNum
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.String authorId
System.String contents
Returns
Type Description
pdftronprivate.PDF.Annot

CreateAnnotationStateReply(String, Int32, PDFViewCtrl, String, String, AnnotReviewState)

Declaration
public static Annot CreateAnnotationStateReply(string parentAnnotId, int pageNum, PDFViewCtrl pdfViewCtrl, string authorId, string authorName, AnnotReviewState state)
Parameters
Type Name Description
System.String parentAnnotId
System.Int32 pageNum
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.String authorId
System.String authorName
AnnotReviewState state
Returns
Type Description
pdftronprivate.PDF.Annot

CreateCustomFreeTextAppearance(View, PDFViewCtrl, Annot, Int32, Rect)

Declaration
public static void CreateCustomFreeTextAppearance(View view, PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum, Rect bbox)
Parameters
Type Name Description
Android.Views.View view
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
pdftronprivate.PDF.Rect bbox

CreateCustomFreeTextAppearance(View, PDFViewCtrl, Annot, Int32, Rect, Boolean)

Declaration
public static void CreateCustomFreeTextAppearance(View view, PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum, Rect bbox, bool useBBoxLocation)
Parameters
Type Name Description
Android.Views.View view
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
pdftronprivate.PDF.Rect bbox
System.Boolean useBBoxLocation

CreateCustomFreeTextAppearance(View, PDFViewCtrl, Annot, Int32, Rect, Boolean, AnnotStyle)

Declaration
public static void CreateCustomFreeTextAppearance(View view, PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum, Rect bbox, bool useBBoxLocation, AnnotStyle annotStyle)
Parameters
Type Name Description
Android.Views.View view
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
pdftronprivate.PDF.Rect bbox
System.Boolean useBBoxLocation
AnnotStyle annotStyle

CreatePdfFromView(View, Int32, Int32, File)

Declaration
public static File CreatePdfFromView(View content, int width, int height, File outputFile)
Parameters
Type Name Description
Android.Views.View content
System.Int32 width
System.Int32 height
Java.IO.File outputFile
Returns
Type Description
Java.IO.File

CreateScreenshot(File, PDFDoc, Annot, Int32)

Declaration
public static string CreateScreenshot(File tempDir, PDFDoc pdfDoc, Annot annot, int pageNum)
Parameters
Type Name Description
Java.IO.File tempDir
pdftronprivate.PDF.PDFDoc pdfDoc
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
Returns
Type Description
System.String

CreateSoundAnnotation(PDFViewCtrl, PointF, Int32, String)

Declaration
public static void CreateSoundAnnotation(PDFViewCtrl pdfViewCtrl, PointF targetPagePoint, int pageNum, string outputFile)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
Android.Graphics.PointF targetPagePoint
System.Int32 pageNum
System.String outputFile

DeleteAllAnnotsByType(PDFDoc, Int32)

Declaration
public static void DeleteAllAnnotsByType(PDFDoc doc, int type)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc doc
System.Int32 type

DeleteAnnotationReply(String, Int32, PDFViewCtrl, ToolManager)

Declaration
public static void DeleteAnnotationReply(string replyId, int pageNum, PDFViewCtrl pdfViewCtrl, ToolManager toolManager)
Parameters
Type Name Description
System.String replyId
System.Int32 pageNum
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
ToolManager toolManager

DeserializeRect(String)

Declaration
public static Rect DeserializeRect(string rectStr)
Parameters
Type Name Description
System.String rectStr
Returns
Type Description
pdftronprivate.PDF.Rect

FlattenAnnot(PDFViewCtrl, Annot, Int32)

Declaration
public static Annot FlattenAnnot(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
Returns
Type Description
pdftronprivate.PDF.Annot

GetAllRedactions(PDFViewCtrl)

Declaration
public static IList<Pair> GetAllRedactions(PDFViewCtrl pdfViewCtrl)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
Returns
Type Description
System.Collections.Generic.IList<Android.Util.Pair>

GetAnnotationAppearance(PDFViewCtrl, Annot)

Declaration
public static Bitmap GetAnnotationAppearance(PDFViewCtrl pdfViewCtrl, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
Returns
Type Description
Android.Graphics.Bitmap

GetAnnotationCountOnPage(PDFViewCtrl, Int32, IList<Integer>)

Declaration
public static int GetAnnotationCountOnPage(PDFViewCtrl pdfViewCtrl, int pageNum, IList<Integer> excludeType)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.Int32 pageNum
System.Collections.Generic.IList<Java.Lang.Integer> excludeType
Returns
Type Description
System.Int32

GetAnnotationsInGroup(PDFViewCtrl, Annot, Int32)

Declaration
public static IList<Annot> GetAnnotationsInGroup(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum
Returns
Type Description
System.Collections.Generic.IList<pdftronprivate.PDF.Annot>

GetAnnotBaseRotation(PDFViewCtrl, Int32)

Declaration
public static int GetAnnotBaseRotation(PDFViewCtrl pdfViewCtrl, int pageNumber)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.Int32 pageNumber
Returns
Type Description
System.Int32

GetAnnotColor(Annot)

Declaration
public static int GetAnnotColor(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Int32

GetAnnotContents(PDFDoc, Annot)

Declaration
public static string GetAnnotContents(PDFDoc pdfDoc, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc pdfDoc
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetAnnotImageResId(Int32)

Declaration
public static int GetAnnotImageResId(int type)
Parameters
Type Name Description
System.Int32 type
Returns
Type Description
System.Int32

GetAnnotLocalCreationDate(Annot)

Declaration
public static Date GetAnnotLocalCreationDate(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
Java.Util.Date

GetAnnotLocalDate(Annot)

Declaration
public static Date GetAnnotLocalDate(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
Java.Util.Date

GetAnnotOpacity(Annot)

Declaration
public static float GetAnnotOpacity(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Single

GetAnnotRotation(Annot)

Declaration
public static int GetAnnotRotation(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Int32

GetAnnotRotationRelToPage(PDFViewCtrl, Annot, Int32)

Declaration
public static int GetAnnotRotationRelToPage(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNumber)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNumber
Returns
Type Description
System.Int32

GetAnnotStyle(Annot)

Declaration
public static AnnotStyle GetAnnotStyle(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
AnnotStyle

GetAnnotType(Annot)

Declaration
public static int GetAnnotType(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Int32

GetAnnotTypeAsPluralString(Context, Annot)

Declaration
public static string GetAnnotTypeAsPluralString(Context context, Annot annot)
Parameters
Type Name Description
Android.Content.Context context
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetAnnotTypeAsPluralString(Annot)

Declaration
public static string GetAnnotTypeAsPluralString(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetAnnotTypeAsString(Context, Annot)

Declaration
public static string GetAnnotTypeAsString(Context context, Annot annot)
Parameters
Type Name Description
Android.Content.Context context
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetAnnotTypeAsString(Context, Int32)

Declaration
public static string GetAnnotTypeAsString(Context context, int typeId)
Parameters
Type Name Description
Android.Content.Context context
System.Int32 typeId
Returns
Type Description
System.String

GetAnnotTypeAsString(Annot)

Declaration
public static string GetAnnotTypeAsString(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetAnnotUIRotation(PDFViewCtrl, Annot, Int32)

Declaration
public static int GetAnnotUIRotation(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNumber)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNumber
Returns
Type Description
System.Int32

GetAssociatedAnnotation(PDFViewCtrl, SignatureWidget, Int32)

Declaration
public static Annot GetAssociatedAnnotation(PDFViewCtrl pdfViewCtrl, SignatureWidget signatureWidget, int pageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annots.SignatureWidget signatureWidget
System.Int32 pageNum
Returns
Type Description
pdftronprivate.PDF.Annot

GetAuthor(Annot)

Declaration
public static string GetAuthor(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetCurrentTime(String)

Declaration
public static string GetCurrentTime(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
System.String

GetFileAttachment(PDFViewCtrl, Annot)

Declaration
public static FileAttachment GetFileAttachment(PDFViewCtrl pdfViewCtrl, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
Returns
Type Description
pdftronprivate.PDF.Annots.FileAttachment

GetFormFieldBackgroundOpacity(Annot)

Declaration
public static double GetFormFieldBackgroundOpacity(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Double

GetIRTAsString(Annot)

Declaration
public static string GetIRTAsString(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.String

GetLineEndingStyle(Line, Boolean)

Declaration
public static LineEndingStyle GetLineEndingStyle(Line line, bool lineStart)
Parameters
Type Name Description
pdftronprivate.PDF.Annots.Line line
System.Boolean lineStart
Returns
Type Description
LineEndingStyle

GetOldAnnotScreenPosition(PDFViewCtrl, Annot, Int32)

Declaration
public static Rect GetOldAnnotScreenPosition(PDFViewCtrl pdfViewCtrl, Annot annot, int annotPageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 annotPageNum
Returns
Type Description
pdftronprivate.PDF.Rect

GetPageRectFromScreenRect(PDFViewCtrl, Rect, Int32)

Declaration
public static Rect GetPageRectFromScreenRect(PDFViewCtrl pdfViewCtrl, Rect screenRect, int pg)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Rect screenRect
System.Int32 pg
Returns
Type Description
pdftronprivate.PDF.Rect

GetPageRectFromScreenRect(PDFViewCtrl, Rect, Int32, Int32)

Declaration
public static Rect GetPageRectFromScreenRect(PDFViewCtrl pdfViewCtrl, Rect screenRect, int pg, int rotation)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Rect screenRect
System.Int32 pg
System.Int32 rotation
Returns
Type Description
pdftronprivate.PDF.Rect

GetPolyVertices(Annot)

Declaration
public static IList<Point> GetPolyVertices(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Collections.Generic.IList<pdftronprivate.PDF.Point>

GetPrimaryAnnotInGroup(PDFViewCtrl, IList<Annot>)

Declaration
public static Annot GetPrimaryAnnotInGroup(PDFViewCtrl pdfViewCtrl, IList<Annot> annots)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.Collections.Generic.IList<pdftronprivate.PDF.Annot> annots
Returns
Type Description
pdftronprivate.PDF.Annot

GetScreenRectFromPageRect(PDFViewCtrl, Rect, Int32)

Declaration
public static RectF GetScreenRectFromPageRect(PDFViewCtrl pdfViewCtrl, Rect pageRect, int pg)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Rect pageRect
System.Int32 pg
Returns
Type Description
Android.Graphics.RectF

GetStampDegree(Annot)

Declaration
public static int GetStampDegree(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Int32

GetStampDegreeOld(Annot)

Declaration
public static int GetStampDegreeOld(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Int32

GetStampSize(Context, String)

Declaration
public static double[] GetStampSize(Context context, string stampName)
Parameters
Type Name Description
Android.Content.Context context
System.String stampName
Returns
Type Description
System.Double[]

GetStandardStampBitmapFromPdf(Context, String, Int32, Int32)

Declaration
public static Bitmap GetStandardStampBitmapFromPdf(Context context, string stampLabel, int bgColor, int height)
Parameters
Type Name Description
Android.Content.Context context
System.String stampLabel
System.Int32 bgColor
System.Int32 height
Returns
Type Description
Android.Graphics.Bitmap

GetStandardStampImageFileFromName(Context, StandardStampPreviewAppearance, Int32)

Declaration
public static string GetStandardStampImageFileFromName(Context context, StandardStampPreviewAppearance stampPreviewAppearance, int height)
Parameters
Type Name Description
Android.Content.Context context
StandardStampPreviewAppearance stampPreviewAppearance
System.Int32 height
Returns
Type Description
System.String

GetUnrotatedBBox(Annot)

Declaration
public static Rect GetUnrotatedBBox(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
pdftronprivate.PDF.Rect

HasPermission(PDFDoc, ToolManager, Annot, Int32)

Declaration
public static bool HasPermission(PDFDoc pdfDoc, ToolManager toolManager, Annot annot, int kind)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc pdfDoc
ToolManager toolManager
pdftronprivate.PDF.Annot annot
System.Int32 kind
Returns
Type Description
System.Boolean

HasPermission(PDFViewCtrl, Annot, Int32)

Declaration
public static bool HasPermission(PDFViewCtrl pdfViewCtrl, Annot annot, int kind)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 kind
Returns
Type Description
System.Boolean

HasPermission(PDFViewCtrl, PDFDoc, ToolManager, Annot, Int32)

Declaration
public static bool HasPermission(PDFViewCtrl pdfViewCtrl, PDFDoc pdfDoc, ToolManager tm, Annot annot, int kind)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.PDFDoc pdfDoc
ToolManager tm
pdftronprivate.PDF.Annot annot
System.Int32 kind
Returns
Type Description
System.Boolean

HasReplyTypeGroup(Annot)

Declaration
public static bool HasReplyTypeGroup(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

HasReplyTypeReply(Annot)

Declaration
public static bool HasReplyTypeReply(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

HasRotation(Annot)

Declaration
public static bool HasRotation(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

HasRotation(PDFViewCtrl, Annot)

Declaration
public static bool HasRotation(PDFViewCtrl pdfViewCtrl, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsAreaMeasure(Annot)

Declaration
public static bool IsAreaMeasure(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsArrow(Annot)

Declaration
public static bool IsArrow(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsBasicFreeText(Annot)

Declaration
public static bool IsBasicFreeText(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsCallout(Annot)

Declaration
public static bool IsCallout(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsCloud(Annot)

Declaration
public static bool IsCloud(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsCountMeasurement(Annot)

Declaration
public static bool IsCountMeasurement(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsFreeHighlighter(Annot)

Declaration
public static bool IsFreeHighlighter(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsFreeTextDate(Annot)

Declaration
public static bool IsFreeTextDate(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsFreeTextSpacing(Annot)

Declaration
public static bool IsFreeTextSpacing(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsGroupSelected(PDFViewCtrl, IList<Annot>, Int32)

Declaration
public static bool IsGroupSelected(PDFViewCtrl pdfViewCtrl, IList<Annot> selected, int page)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.Collections.Generic.IList<pdftronprivate.PDF.Annot> selected
System.Int32 page
Returns
Type Description
System.Boolean

IsImageStamp(Annot)

Declaration
public static bool IsImageStamp(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsListBox(Annot)

Declaration
public static bool IsListBox(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsMadeByPDFTron(Annot)

Declaration
public static bool IsMadeByPDFTron(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsPerimeterMeasure(Annot)

Declaration
public static bool IsPerimeterMeasure(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsRectAreaMeasure(Annot)

Declaration
public static bool IsRectAreaMeasure(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsRuler(Annot)

Declaration
public static bool IsRuler(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsSignature(Annot)

Declaration
public static bool IsSignature(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsSimpleLine(Annot)

Declaration
public static bool IsSimpleLine(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

IsTextField(Annot)

Declaration
public static bool IsTextField(Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

PutStampDegree(Annot, Int32)

Declaration
public static void PutStampDegree(Annot annot, int rotation)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
System.Int32 rotation

RefreshAnnotAppearance(Context, Annot)

Declaration
public static void RefreshAnnotAppearance(Context context, Annot annot)
Parameters
Type Name Description
Android.Content.Context context
pdftronprivate.PDF.Annot annot

RefreshCustomFreeTextAppearance(File, Annot)

Declaration
public static bool RefreshCustomFreeTextAppearance(File appearance, Annot annot)
Parameters
Type Name Description
Java.IO.File appearance
pdftronprivate.PDF.Annot annot
Returns
Type Description
System.Boolean

SafeDeleteAllAnnots(PDFDoc)

Declaration
public static void SafeDeleteAllAnnots(PDFDoc doc)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc doc

SafeDeleteAnnot(PDFDoc, Page, Annot)

Declaration
public static Annot SafeDeleteAnnot(PDFDoc pdfDoc, Page page, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc pdfDoc
pdftronprivate.PDF.Page page
pdftronprivate.PDF.Annot annot
Returns
Type Description
pdftronprivate.PDF.Annot

SafeDeleteAnnotAndUpdate(PDFViewCtrl, Page, Annot, Int32)

Declaration
public static Annot SafeDeleteAnnotAndUpdate(PDFViewCtrl pdfViewCtrl, Page page, Annot annot, int annotPageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Page page
pdftronprivate.PDF.Annot annot
System.Int32 annotPageNum
Returns
Type Description
pdftronprivate.PDF.Annot

SafeDeleteAnnotsOnPage(PDFDoc, IList<Integer>)

Declaration
public static void SafeDeleteAnnotsOnPage(PDFDoc doc, IList<Integer> pages)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc doc
System.Collections.Generic.IList<Java.Lang.Integer> pages

SaveFreeTextCache(FreeTextCacheStruct, PDFViewCtrl)

Declaration
public static void SaveFreeTextCache(FreeTextCacheStruct freeTextCacheStruct, PDFViewCtrl pdfViewCtrl)
Parameters
Type Name Description
FreeTextCacheStruct freeTextCacheStruct
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl

SaveUnrotatedBBox(PDFViewCtrl, Annot, Int32)

Declaration
public static void SaveUnrotatedBBox(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot
System.Int32 pageNum

SerializeRect(Rect)

Declaration
public static string SerializeRect(Rect rect)
Parameters
Type Name Description
pdftronprivate.PDF.Rect rect
Returns
Type Description
System.String

SetAnnotContents(PDFDoc, Markup, String)

Declaration
public static void SetAnnotContents(PDFDoc pdfDoc, Markup markup, string newContent)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc pdfDoc
pdftronprivate.PDF.Annots.Markup markup
System.String newContent

SetAuthor(Annot, String)

Declaration
public static void SetAuthor(Annot annot, string author)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
System.String author

SetAuthor(Markup, String)

Declaration
public static void SetAuthor(Markup markup, string author)
Parameters
Type Name Description
pdftronprivate.PDF.Annots.Markup markup
System.String author

SetBorderStyle(Annot, Int32, Int32, Double[])

Declaration
public static void SetBorderStyle(Annot annot, int effect, int style, double[] dash)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
System.Int32 effect
System.Int32 style
System.Double[] dash

SetDateToNow(PDFViewCtrl, Annot)

Declaration
public static void SetDateToNow(PDFViewCtrl pdfViewCtrl, Annot annot)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
pdftronprivate.PDF.Annot annot

SetLineEndingStyle(Line, LineEndingStyle, Boolean)

Declaration
public static void SetLineEndingStyle(Line line, LineEndingStyle lineEndingStyle, Boolean lineStart)
Parameters
Type Name Description
pdftronprivate.PDF.Annots.Line line
LineEndingStyle lineEndingStyle
Java.Lang.Boolean lineStart

SetStyle(Annot, Boolean, Int32, Int32, Single, Single)

Declaration
public static void SetStyle(Annot annot, bool hasFill, int strokeColor, int fillColor, float thickness, float opacity)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
System.Boolean hasFill
System.Int32 strokeColor
System.Int32 fillColor
System.Single thickness
System.Single opacity

SetUniqueId(Annot, String)

Declaration
public static void SetUniqueId(Annot annot, string id)
Parameters
Type Name Description
pdftronprivate.PDF.Annot annot
System.String id

SimpleXmlParser(String)

Declaration
public static JSONObject SimpleXmlParser(string xfdfCommand)
Parameters
Type Name Description
System.String xfdfCommand
Returns
Type Description
Org.Json.JSONObject

UngroupAnnotations(PDFViewCtrl, IList<Annot>)

Declaration
public static void UngroupAnnotations(PDFViewCtrl pdfViewCtrl, IList<Annot> allInGroup)
Parameters
Type Name Description
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
System.Collections.Generic.IList<pdftronprivate.PDF.Annot> allInGroup

UpdateAnnotationReply(String, Int32, PDFViewCtrl, ToolManager, String)

Declaration
public static Annot UpdateAnnotationReply(string replyId, int pageNum, PDFViewCtrl pdfViewCtrl, ToolManager toolManager, string contents)
Parameters
Type Name Description
System.String replyId
System.Int32 pageNum
pdftronprivate.PDF.PDFViewCtrl pdfViewCtrl
ToolManager toolManager
System.String contents
Returns
Type Description
pdftronprivate.PDF.Annot

XfdfCommandExtract(PDFDoc, IList<String>, IList<String>, IList<String>)

Declaration
public static string XfdfCommandExtract(PDFDoc pdfDoc, IList<string> annotIdsAdded, IList<string> annotIdsModified, IList<string> annotIdsDeleted)
Parameters
Type Name Description
pdftronprivate.PDF.PDFDoc pdfDoc
System.Collections.Generic.IList<System.String> annotIdsAdded
System.Collections.Generic.IList<System.String> annotIdsModified
System.Collections.Generic.IList<System.String> annotIdsDeleted
Returns
Type Description
System.String
In This Article
Back to top Generated by DocFX