Show / Hide Table of Contents

Class PTPDFViewCtrl

Inheritance
System.Object
PTPDFViewCtrl
PDFViewCtrl
Implements
UIKit.IUIGestureRecognizerDelegate
ObjCRuntime.INativeObject
System.IDisposable
UIKit.IUIPrintInteractionControllerDelegate
UIKit.IUIScrollViewDelegate
Namespace: pdftron.PDF
Assembly: PDFNetiOS.dll
Syntax
public class PTPDFViewCtrl : UIView, IUIGestureRecognizerDelegate, INativeObject, IDisposable, IUIPrintInteractionControllerDelegate, IUIScrollViewDelegate

Constructors

PTPDFViewCtrl()

Declaration
public PTPDFViewCtrl()

PTPDFViewCtrl(CGRect)

Declaration
public PTPDFViewCtrl(CGRect frame)
Parameters
Type Name Description
CoreGraphics.CGRect frame

PTPDFViewCtrl(NSCoder)

Declaration
public PTPDFViewCtrl(NSCoder coder)
Parameters
Type Name Description
Foundation.NSCoder coder

PTPDFViewCtrl(NSObjectFlag)

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

PTPDFViewCtrl(IntPtr)

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

Properties

AdditionalYOffset

Declaration
public virtual nfloat AdditionalYOffset { get; set; }
Property Value
Type Description
System.nfloat

Appearance

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance Appearance { get; }
Property Value
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance

CanRedo

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

CanUndo

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

CanvasHeight

Declaration
public virtual double CanvasHeight { get; }
Property Value
Type Description
System.Double

CanvasWidth

Declaration
public virtual double CanvasWidth { get; }
Property Value
Type Description
System.Double

ClassHandle

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

ContentInsetAdjustmentBehavior

Declaration
public virtual UIScrollViewContentInsetAdjustmentBehavior ContentInsetAdjustmentBehavior { get; set; }
Property Value
Type Description
UIKit.UIScrollViewContentInsetAdjustmentBehavior

Delegate

Declaration
public PTPDFViewCtrlDelegate Delegate { get; set; }
Property Value
Type Description
PTPDFViewCtrlDelegate

DirectionalLockEnabled

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

ExternalAnnotManager

Declaration
public virtual PTExternalAnnotManager ExternalAnnotManager { get; }
Property Value
Type Description
PTExternalAnnotManager

GetDocumentConversion

Declaration
public virtual PTDocumentConversion GetDocumentConversion { get; }
Property Value
Type Description
PTDocumentConversion

GetRightToLeftLanguage

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

HasSelection

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

InsetOffsets

Declaration
public virtual CGPoint InsetOffsets { get; }
Property Value
Type Description
CoreGraphics.CGPoint

NextRedoInfo

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

NextUndoInfo

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

OuterScrollViewShouldScrollToTop

Declaration
public OuterScrollViewShouldScrollToTop OuterScrollViewShouldScrollToTop { get; set; }
Property Value
Type Description
OuterScrollViewShouldScrollToTop

OverlayView

Declaration
public virtual UIView OverlayView { get; }
Property Value
Type Description
UIKit.UIView

PageCount

Declaration
public virtual int PageCount { get; }
Property Value
Type Description
System.Int32

PagePresentationModeIsContinuous

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

PagingDirection

Declaration
public virtual PTPDFViewCtrlPagingDirection PagingDirection { get; set; }
Property Value
Type Description
PTPDFViewCtrlPagingDirection

PdfScrollViewShouldScrollToTop

Declaration
public PdfScrollViewShouldScrollToTop PdfScrollViewShouldScrollToTop { get; set; }
Property Value
Type Description
PdfScrollViewShouldScrollToTop

PurgeMemoryOnMemoryWarning

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

RetinaEnabled

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

Rotation

Declaration
public virtual RotationModes Rotation { get; }
Property Value
Type Description
RotationModes

ScrollEnabled

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

SelectionBeginPage

Declaration
public virtual int SelectionBeginPage { get; }
Property Value
Type Description
System.Int32

SelectionEndPage

Declaration
public virtual int SelectionEndPage { get; }
Property Value
Type Description
System.Int32

ToolDelegate

Declaration
public PTPDFViewCtrlToolDelegate ToolDelegate { get; set; }
Property Value
Type Description
PTPDFViewCtrlToolDelegate

ToolOverlayView

Declaration
public virtual UIView ToolOverlayView { get; }
Property Value
Type Description
UIKit.UIView

UndoManager

Declaration
public virtual NSUndoManager UndoManager { get; }
Property Value
Type Description
Foundation.NSUndoManager

UndoRedoEnabled

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

VisiblePages

Declaration
public virtual NSMutableArray<NSNumber> VisiblePages { get; }
Property Value
Type Description
Foundation.NSMutableArray<Foundation.NSNumber>

WeakDelegate

Declaration
public virtual NSObject WeakDelegate { get; set; }
Property Value
Type Description
Foundation.NSObject

WeakToolDelegate

Declaration
public virtual NSObject WeakToolDelegate { get; set; }
Property Value
Type Description
Foundation.NSObject

ZoomEnabled

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

ZoomLimitMode

Declaration
public virtual ZoomLimitModes ZoomLimitMode { get; }
Property Value
Type Description
ZoomLimitModes

ZoomMaximumLimit

Declaration
public virtual double ZoomMaximumLimit { get; }
Property Value
Type Description
System.Double

ZoomMinimumLimit

Declaration
public virtual double ZoomMinimumLimit { get; }
Property Value
Type Description
System.Double

ZoomScale

Declaration
public virtual double ZoomScale { get; }
Property Value
Type Description
System.Double

Methods

AddFloatingView(UIView)

Declaration
public virtual void AddFloatingView(UIView view)
Parameters
Type Name Description
UIKit.UIView view

AddFloatingView(UIView, Int32, PTPDFPoint)

Declaration
public virtual void AddFloatingView(UIView view, int pageNumber, PTPDFPoint pageSpacePoint)
Parameters
Type Name Description
UIKit.UIView view
System.Int32 pageNumber
PTPDFPoint pageSpacePoint

AddFloatingView(UIView, Int32, PTPDFRect, Boolean)

Declaration
public virtual void AddFloatingView(UIView view, int pageNumber, PTPDFRect pageSpaceRect, bool noZoom)
Parameters
Type Name Description
UIKit.UIView view
System.Int32 pageNumber
PTPDFRect pageSpaceRect
System.Boolean noZoom

AppearanceWhenContainedIn(Type[])

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance AppearanceWhenContainedIn(params Type[] containers)
Parameters
Type Name Description
System.Type[] containers
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance

CancelAllThumbRequests()

Declaration
public virtual void CancelAllThumbRequests()

CancelFindText()

Declaration
public virtual void CancelFindText()

CancelRendering()

Declaration
public virtual void CancelRendering()

CGRectScreen2PDFRectPage(CGRect, Int32)

Declaration
public virtual PTPDFRect CGRectScreen2PDFRectPage(CGRect cgRect, int pageNumber)
Parameters
Type Name Description
CoreGraphics.CGRect cgRect
System.Int32 pageNumber
Returns
Type Description
PTPDFRect

ClearFloatingViewPageCache()

Declaration
public virtual void ClearFloatingViewPageCache()

ClearFloatingViews()

Declaration
public virtual void ClearFloatingViews()

ClearSelection()

Declaration
public virtual void ClearSelection()

ClearThumbCache()

Declaration
public virtual void ClearThumbCache()

CloseDoc()

Declaration
public virtual void CloseDoc()

ConvCanvasPtToPagePt(PTPDFPoint, Int32)

Declaration
public virtual PTPDFPoint ConvCanvasPtToPagePt(PTPDFPoint pt, int page_num)
Parameters
Type Name Description
PTPDFPoint pt
System.Int32 page_num
Returns
Type Description
PTPDFPoint

ConvCanvasPtToScreenPt(PTPDFPoint)

Declaration
public virtual PTPDFPoint ConvCanvasPtToScreenPt(PTPDFPoint pt)
Parameters
Type Name Description
PTPDFPoint pt
Returns
Type Description
PTPDFPoint

ConvPagePtToCanvasPt(PTPDFPoint, Int32)

Declaration
public virtual PTPDFPoint ConvPagePtToCanvasPt(PTPDFPoint pt, int page_num)
Parameters
Type Name Description
PTPDFPoint pt
System.Int32 page_num
Returns
Type Description
PTPDFPoint

ConvPagePtToScreenPt(PTPDFPoint, Int32)

Declaration
public virtual PTPDFPoint ConvPagePtToScreenPt(PTPDFPoint pt, int page_num)
Parameters
Type Name Description
PTPDFPoint pt
System.Int32 page_num
Returns
Type Description
PTPDFPoint

ConvScreenPtToCanvasPt(PTPDFPoint)

Declaration
public virtual PTPDFPoint ConvScreenPtToCanvasPt(PTPDFPoint pt)
Parameters
Type Name Description
PTPDFPoint pt
Returns
Type Description
PTPDFPoint

ConvScreenPtToPagePt(PTPDFPoint, Int32)

Declaration
public virtual PTPDFPoint ConvScreenPtToPagePt(PTPDFPoint pt, int page_num)
Parameters
Type Name Description
PTPDFPoint pt
System.Int32 page_num
Returns
Type Description
PTPDFPoint

Dispose(Boolean)

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

DocLock(Boolean)

Declaration
public virtual void DocLock(bool cancelThreads)
Parameters
Type Name Description
System.Boolean cancelThreads

DocLockRead()

Declaration
public virtual void DocLockRead()

DocTryLock(Int32)

Declaration
public virtual bool DocTryLock(int milliseconds)
Parameters
Type Name Description
System.Int32 milliseconds
Returns
Type Description
System.Boolean

DocTryLockRead(Int32)

Declaration
public virtual bool DocTryLockRead(int milliseconds)
Parameters
Type Name Description
System.Int32 milliseconds
Returns
Type Description
System.Boolean

DocUnlock()

Declaration
public virtual void DocUnlock()

DocUnlockRead()

Declaration
public virtual void DocUnlockRead()

EnableAnnotationManager(String)

Declaration
public virtual PTExternalAnnotManager EnableAnnotationManager(string userID)
Parameters
Type Name Description
System.String userID
Returns
Type Description
PTExternalAnnotManager

EnableAnnotationManager(String, PTExternalAnnotManagerMode)

Declaration
public virtual PTExternalAnnotManager EnableAnnotationManager(string userID, PTExternalAnnotManagerMode mode)
Parameters
Type Name Description
System.String userID
PTExternalAnnotManagerMode mode
Returns
Type Description
PTExternalAnnotManager

EnableUndoRedo()

Declaration
public virtual void EnableUndoRedo()

ExecuteAction(PTAction)

Declaration
public virtual void ExecuteAction(PTAction action)
Parameters
Type Name Description
PTAction action

ExecuteActionWithActionParameter(PTActionParameter)

Declaration
public virtual void ExecuteActionWithActionParameter(PTActionParameter action_param)
Parameters
Type Name Description
PTActionParameter action_param

FindText(String, Boolean, Boolean, Boolean, Boolean)

Declaration
public virtual bool FindText(string searchString, bool matchCase, bool matchWholeWord, bool searchUp, bool regExp)
Parameters
Type Name Description
System.String searchString
System.Boolean matchCase
System.Boolean matchWholeWord
System.Boolean searchUp
System.Boolean regExp
Returns
Type Description
System.Boolean

FloatingViewsOnPage(Int32)

Declaration
public virtual UIView[] FloatingViewsOnPage(int pageNumber)
Parameters
Type Name Description
System.Int32 pageNumber
Returns
Type Description
UIKit.UIView[]

GetAnnotationAt(Int32, Int32, Double, Double)

Declaration
public virtual PTAnnot GetAnnotationAt(int x, int y, double distanceThreshold, double minimumLineWeight)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Double distanceThreshold
System.Double minimumLineWeight
Returns
Type Description
PTAnnot

GetAnnotationListAt(Int32, Int32, Int32, Int32)

Declaration
public virtual PTAnnot[] GetAnnotationListAt(int x1, int y1, int x2, int y2)
Parameters
Type Name Description
System.Int32 x1
System.Int32 y1
System.Int32 x2
System.Int32 y2
Returns
Type Description
PTAnnot[]

GetAnnotationsOnPage(Int32)

Declaration
public virtual PTAnnot[] GetAnnotationsOnPage(int page_num)
Parameters
Type Name Description
System.Int32 page_num
Returns
Type Description
PTAnnot[]

GetAppearance(UITraitCollection)

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance GetAppearance(UITraitCollection traits)
Parameters
Type Name Description
UIKit.UITraitCollection traits
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance

GetAppearance(UITraitCollection, Type[])

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance GetAppearance(UITraitCollection traits, params Type[] containers)
Parameters
Type Name Description
UIKit.UITraitCollection traits
System.Type[] containers
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance

GetAppearance<T>()

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance GetAppearance<T>()
    where T : PTPDFViewCtrl
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance
Type Parameters
Name Description
T

GetAppearance<T>(UITraitCollection)

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance GetAppearance<T>(UITraitCollection traits)
    where T : PTPDFViewCtrl
Parameters
Type Name Description
UIKit.UITraitCollection traits
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance
Type Parameters
Name Description
T

GetAppearance<T>(UITraitCollection, Type[])

Declaration
public static PTPDFViewCtrl.PTPDFViewCtrlAppearance GetAppearance<T>(UITraitCollection traits, params Type[] containers)
    where T : PTPDFViewCtrl
Parameters
Type Name Description
UIKit.UITraitCollection traits
System.Type[] containers
Returns
Type Description
PTPDFViewCtrl.PTPDFViewCtrlAppearance
Type Parameters
Name Description
T

GetColorPostProcessMode()

Declaration
public virtual ColorPostProcessMode GetColorPostProcessMode()
Returns
Type Description
ColorPostProcessMode

GetCurrentPage()

Declaration
public virtual int GetCurrentPage()
Returns
Type Description
System.Int32

GetDeviceTransform(Int32)

Declaration
public virtual PTMatrix2D GetDeviceTransform(int page_num)
Parameters
Type Name Description
System.Int32 page_num
Returns
Type Description
PTMatrix2D

GetDoc()

Declaration
public virtual PTPDFDoc GetDoc()
Returns
Type Description
PTPDFDoc

GetExternalAnnotManager(String, PTExternalAnnotManagerMode)

Declaration
public virtual PTExternalAnnotManager GetExternalAnnotManager(string author, PTExternalAnnotManagerMode mode)
Parameters
Type Name Description
System.String author
PTExternalAnnotManagerMode mode
Returns
Type Description
PTExternalAnnotManager

GetHScrollPos()

Declaration
public virtual double GetHScrollPos()
Returns
Type Description
System.Double

GetLinkAt(Int32, Int32)

Declaration
public virtual PTLinkInfo GetLinkAt(int x, int y)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
Returns
Type Description
PTLinkInfo

GetOCGContext()

Declaration
public virtual PTContext GetOCGContext()
Returns
Type Description
PTContext

GetPageNumberFromScreenPt(Double, Double)

Declaration
public virtual int GetPageNumberFromScreenPt(double x, double y)
Parameters
Type Name Description
System.Double x
System.Double y
Returns
Type Description
System.Int32

GetPagePresentationMode()

Declaration
public virtual PagePresentationModes GetPagePresentationMode()
Returns
Type Description
PagePresentationModes

GetPageRefViewMode()

Declaration
public virtual PageViewModes GetPageRefViewMode()
Returns
Type Description
PageViewModes

GetPageViewMode()

Declaration
public virtual PageViewModes GetPageViewMode()
Returns
Type Description
PageViewModes

GetPostProcessedColor(PTColorPt)

Declaration
public virtual PTColorPt GetPostProcessedColor(PTColorPt color)
Parameters
Type Name Description
PTColorPt color
Returns
Type Description
PTColorPt

GetScreenRectForAnnot(PTAnnot, Int32)

Declaration
public virtual PTPDFRect GetScreenRectForAnnot(PTAnnot annot, int page_num)
Parameters
Type Name Description
PTAnnot annot
System.Int32 page_num
Returns
Type Description
PTPDFRect

GetSelection(Int32)

Declaration
public virtual PTSelection GetSelection(int pagenum)
Parameters
Type Name Description
System.Int32 pagenum
Returns
Type Description
PTSelection

GetThumbAsync(Int32)

Declaration
public virtual void GetThumbAsync(int page_num)
Parameters
Type Name Description
System.Int32 page_num

GetVScrollPos()

Declaration
public virtual double GetVScrollPos()
Returns
Type Description
System.Double

GetZoom()

Declaration
public virtual double GetZoom()
Returns
Type Description
System.Double

GotoFirstPage()

Declaration
public virtual bool GotoFirstPage()
Returns
Type Description
System.Boolean

GotoLastPage()

Declaration
public virtual bool GotoLastPage()
Returns
Type Description
System.Boolean

GotoNextPage()

Declaration
public virtual bool GotoNextPage()
Returns
Type Description
System.Boolean

GotoPreviousPage()

Declaration
public virtual bool GotoPreviousPage()
Returns
Type Description
System.Boolean

HandleLongPress(UILongPressGestureRecognizer)

Declaration
public virtual void HandleLongPress(UILongPressGestureRecognizer gestureRecognizer)
Parameters
Type Name Description
UIKit.UILongPressGestureRecognizer gestureRecognizer

HandleTap(UITapGestureRecognizer)

Declaration
public virtual void HandleTap(UITapGestureRecognizer gestureRecognizer)
Parameters
Type Name Description
UIKit.UITapGestureRecognizer gestureRecognizer

HasSelectionOnPage(Int32)

Declaration
public virtual bool HasSelectionOnPage(int ipage)
Parameters
Type Name Description
System.Int32 ipage
Returns
Type Description
System.Boolean

HideAnnotation(PTAnnot)

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

HideSelectedTextHighlights()

Declaration
public virtual void HideSelectedTextHighlights()

HighlightSelection(PTSelection, UIColor)

Declaration
public virtual void HighlightSelection(PTSelection selection, UIColor color)
Parameters
Type Name Description
PTSelection selection
UIKit.UIColor color

HighlightSelections(PTSelection[], UIColor)

Declaration
public virtual void HighlightSelections(PTSelection[] selections, UIColor color)
Parameters
Type Name Description
PTSelection[] selections
UIKit.UIColor color

IsFinishedRendering(Boolean)

Declaration
public virtual bool IsFinishedRendering(bool visible_region_only)
Parameters
Type Name Description
System.Boolean visible_region_only
Returns
Type Description
System.Boolean

KeyboardWillHide(NSNotification)

Declaration
public virtual void KeyboardWillHide(NSNotification notification)
Parameters
Type Name Description
Foundation.NSNotification notification

KeyboardWillShow(NSNotification, CGRect)

Declaration
public virtual void KeyboardWillShow(NSNotification notification, CGRect rect)
Parameters
Type Name Description
Foundation.NSNotification notification
CoreGraphics.CGRect rect

KeyboardWillShow(NSNotification, CGRect, nfloat)

Declaration
public virtual void KeyboardWillShow(NSNotification notification, CGRect rect, nfloat topEdge)
Parameters
Type Name Description
Foundation.NSNotification notification
CoreGraphics.CGRect rect
System.nfloat topEdge

OpenUniversalDocumentWithConversion(PTDocumentConversion)

Declaration
public virtual void OpenUniversalDocumentWithConversion(PTDocumentConversion conversion)
Parameters
Type Name Description
PTDocumentConversion conversion

OpenUrlAsync(String, String)

Declaration
public virtual void OpenUrlAsync(string url, string password)
Parameters
Type Name Description
System.String url
System.String password

OpenUrlAsync(String, String, String)

Declaration
public virtual void OpenUrlAsync(string url, string password, string fullPath)
Parameters
Type Name Description
System.String url
System.String password
System.String fullPath

OpenUrlAsync(String, String, String, PTHTTPRequestOptions)

Declaration
public virtual void OpenUrlAsync(string url, string password, string fullPath, PTHTTPRequestOptions options)
Parameters
Type Name Description
System.String url
System.String password
System.String fullPath
PTHTTPRequestOptions options

PageBox()

Declaration
public virtual PTBox PageBox()
Returns
Type Description
PTBox

PageIsOnScreen(Int32)

Declaration
public virtual bool PageIsOnScreen(int pageNumber)
Parameters
Type Name Description
System.Int32 pageNumber
Returns
Type Description
System.Boolean

PDFRectPage2CGRectScreen(PTPDFRect, Int32)

Declaration
public virtual CGRect PDFRectPage2CGRectScreen(PTPDFRect pdfRect, int pageNumber)
Parameters
Type Name Description
PTPDFRect pdfRect
System.Int32 pageNumber
Returns
Type Description
CoreGraphics.CGRect

PurgeMemory()

Declaration
public virtual void PurgeMemory()

Redo()

Declaration
public virtual string Redo()
Returns
Type Description
System.String

RefreshAndUpdate(PTViewChangeCollection)

Declaration
public virtual void RefreshAndUpdate(PTViewChangeCollection view_change)
Parameters
Type Name Description
PTViewChangeCollection view_change

RemoveFloatingView(UIView)

Declaration
public virtual void RemoveFloatingView(UIView view)
Parameters
Type Name Description
UIKit.UIView view

RemoveFloatingViews(UIView[])

Declaration
public virtual void RemoveFloatingViews(UIView[] views)
Parameters
Type Name Description
UIKit.UIView[] views

RequestRendering()

Declaration
public virtual void RequestRendering()

RevertAllChanges()

Declaration
public virtual void RevertAllChanges()

RotateClockwise()

Declaration
public virtual void RotateClockwise()

RotateCounterClockwise()

Declaration
public virtual void RotateCounterClockwise()

SelectAll()

Declaration
public virtual void SelectAll()

SelectWithHighlights(PTHighlights)

Declaration
public virtual bool SelectWithHighlights(PTHighlights highlights)
Parameters
Type Name Description
PTHighlights highlights
Returns
Type Description
System.Boolean

SelectWithSelection(PTSelection)

Declaration
public virtual bool SelectWithSelection(PTSelection select)
Parameters
Type Name Description
PTSelection select
Returns
Type Description
System.Boolean

SelectX1(Double, Double, Double, Double)

Declaration
public virtual bool SelectX1(double x1, double y1, double x2, double y2)
Parameters
Type Name Description
System.Double x1
System.Double y1
System.Double x2
System.Double y2
Returns
Type Description
System.Boolean

SelectX1(Double, Double, Int32, Double, Double, Int32)

Declaration
public virtual bool SelectX1(double x1, double y1, int pageNumber1, double x2, double y2, int pageNumber2)
Parameters
Type Name Description
System.Double x1
System.Double y1
System.Int32 pageNumber1
System.Double x2
System.Double y2
System.Int32 pageNumber2
Returns
Type Description
System.Boolean

SetAntiAliasing(Boolean)

Declaration
public virtual void SetAntiAliasing(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetBackgroundColor(Byte, Byte, Byte, Byte)

Declaration
public virtual void SetBackgroundColor(byte r, byte g, byte b, byte a)
Parameters
Type Name Description
System.Byte r
System.Byte g
System.Byte b
System.Byte a

SetCaching(Boolean)

Declaration
public virtual void SetCaching(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetColorPostProcessColors(UIColor, UIColor)

Declaration
public virtual void SetColorPostProcessColors(UIColor white_color, UIColor black_color)
Parameters
Type Name Description
UIKit.UIColor white_color
UIKit.UIColor black_color

SetColorPostProcessMode(ColorPostProcessMode)

Declaration
public virtual void SetColorPostProcessMode(ColorPostProcessMode mode)
Parameters
Type Name Description
ColorPostProcessMode mode

SetCurrentPage(Int32)

Declaration
public virtual bool SetCurrentPage(int page_num)
Parameters
Type Name Description
System.Int32 page_num
Returns
Type Description
System.Boolean

SetDefaultPageColor(Byte, Byte, Byte)

Declaration
public virtual void SetDefaultPageColor(byte r, byte g, byte b)
Parameters
Type Name Description
System.Byte r
System.Byte g
System.Byte b

SetDevicePixelDensity(Double, Double)

Declaration
public virtual void SetDevicePixelDensity(double dpi, double scale_factor)
Parameters
Type Name Description
System.Double dpi
System.Double scale_factor

SetDoc(PTPDFDoc)

Declaration
public virtual void SetDoc(PTPDFDoc doc)
Parameters
Type Name Description
PTPDFDoc doc

SetDrawAnnotations(Boolean)

Declaration
public virtual void SetDrawAnnotations(bool render_annots)
Parameters
Type Name Description
System.Boolean render_annots

SetExtraVerticalContent(Int32)

Declaration
public virtual void SetExtraVerticalContent(int points)
Parameters
Type Name Description
System.Int32 points

SetFieldHighlightColor(UIColor)

Declaration
public virtual void SetFieldHighlightColor(UIColor highlightColor)
Parameters
Type Name Description
UIKit.UIColor highlightColor

SetGamma(Double)

Declaration
public virtual void SetGamma(double exp)
Parameters
Type Name Description
System.Double exp

SetHighlightFields(Boolean)

Declaration
public virtual void SetHighlightFields(bool highlight_fields)
Parameters
Type Name Description
System.Boolean highlight_fields

SetHorizontalAlign(Int32)

Declaration
public virtual void SetHorizontalAlign(int align)
Parameters
Type Name Description
System.Int32 align

SetHScrollPos(Double)

Declaration
public virtual void SetHScrollPos(double pos)
Parameters
Type Name Description
System.Double pos

SetHScrollPos(Double, Boolean)

Declaration
public virtual void SetHScrollPos(double pos, bool animated)
Parameters
Type Name Description
System.Double pos
System.Boolean animated

SetImageSmoothing(Boolean)

Declaration
public virtual void SetImageSmoothing(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetMinimumTwoFingersToScrollEnabled(Boolean)

Declaration
public virtual void SetMinimumTwoFingersToScrollEnabled(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetOCGContext(PTContext)

Declaration
public virtual void SetOCGContext(PTContext ctx)
Parameters
Type Name Description
PTContext ctx

SetOverprint(OverprintPreviewModes)

Declaration
public virtual void SetOverprint(OverprintPreviewModes op)
Parameters
Type Name Description
OverprintPreviewModes op

SetPageBorderVisibility(Boolean)

Declaration
public virtual void SetPageBorderVisibility(bool border_visible)
Parameters
Type Name Description
System.Boolean border_visible

SetPageBox(PTBox)

Declaration
public virtual void SetPageBox(PTBox region)
Parameters
Type Name Description
PTBox region

SetPagePresentationMode(PagePresentationModes)

Declaration
public virtual void SetPagePresentationMode(PagePresentationModes mode)
Parameters
Type Name Description
PagePresentationModes mode

SetPageRefViewMode(PageViewModes)

Declaration
public virtual void SetPageRefViewMode(PageViewModes mode)
Parameters
Type Name Description
PageViewModes mode

SetPageSpacing(Int32, Int32, Int32, Int32)

Declaration
public virtual void SetPageSpacing(int horiz_col_space, int vert_col_space, int horiz_pad, int vert_pad)
Parameters
Type Name Description
System.Int32 horiz_col_space
System.Int32 vert_col_space
System.Int32 horiz_pad
System.Int32 vert_pad

SetPageTransparencyGrid(Boolean)

Declaration
public virtual void SetPageTransparencyGrid(bool trans_grid_visible)
Parameters
Type Name Description
System.Boolean trans_grid_visible

SetPageViewMode(PageViewModes)

Declaration
public virtual void SetPageViewMode(PageViewModes mode)
Parameters
Type Name Description
PageViewModes mode

SetPathHinting(Boolean)

Declaration
public virtual void SetPathHinting(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetProgressiveRendering(Boolean, Int32, Int32)

Declaration
public virtual void SetProgressiveRendering(bool progressive, int delayMilliseconds, int intervalMilliseconds)
Parameters
Type Name Description
System.Boolean progressive
System.Int32 delayMilliseconds
System.Int32 intervalMilliseconds

SetRenderedContentCacheSize(Int64)

Declaration
public virtual void SetRenderedContentCacheSize(long allowedMax)
Parameters
Type Name Description
System.Int64 allowedMax

SetRequiredFieldBorderColor(UIColor)

Declaration
public virtual void SetRequiredFieldBorderColor(UIColor borderColor)
Parameters
Type Name Description
UIKit.UIColor borderColor

SetRightToLeftLanguage(Boolean)

Declaration
public virtual void SetRightToLeftLanguage(bool isRightToLeft)
Parameters
Type Name Description
System.Boolean isRightToLeft

SetSignatureHighlightColor(UIColor)

Declaration
public virtual void SetSignatureHighlightColor(UIColor highlightColor)
Parameters
Type Name Description
UIKit.UIColor highlightColor

SetTextSelectionMode(TextSelectionModes)

Declaration
public virtual void SetTextSelectionMode(TextSelectionModes tm)
Parameters
Type Name Description
TextSelectionModes tm

SetThinLineAdjustment(Boolean, Boolean)

Declaration
public virtual void SetThinLineAdjustment(bool pixel_grid, bool stroke_adjust)
Parameters
Type Name Description
System.Boolean pixel_grid
System.Boolean stroke_adjust

SetupThumbnails(Boolean, Boolean, Boolean, Int32, nuint, Double)

Declaration
public virtual void SetupThumbnails(bool use_embedded, bool generate_at_runtime, bool use_disk_cache, int thumb_max_side_length, nuint max_abs_cache_size, double max_perc_cache_size)
Parameters
Type Name Description
System.Boolean use_embedded
System.Boolean generate_at_runtime
System.Boolean use_disk_cache
System.Int32 thumb_max_side_length
System.nuint max_abs_cache_size
System.Double max_perc_cache_size

SetUrlExtraction(Boolean)

Declaration
public virtual void SetUrlExtraction(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SetVerticalAlign(Int32)

Declaration
public virtual void SetVerticalAlign(int align)
Parameters
Type Name Description
System.Int32 align

SetViewerCache(PTSDFDoc, nuint, Boolean)

Declaration
public static void SetViewerCache(PTSDFDoc document, nuint max_cache_size, bool on_disk)
Parameters
Type Name Description
PTSDFDoc document
System.nuint max_cache_size
System.Boolean on_disk

SetVScrollPos(Double)

Declaration
public virtual void SetVScrollPos(double pos)
Parameters
Type Name Description
System.Double pos

SetVScrollPos(Double, Boolean)

Declaration
public virtual void SetVScrollPos(double pos, bool animated)
Parameters
Type Name Description
System.Double pos
System.Boolean animated

SetZoom(Double)

Declaration
public virtual void SetZoom(double zoom)
Parameters
Type Name Description
System.Double zoom

SetZoomLimits(ZoomLimitModes, Double, Double)

Declaration
public virtual void SetZoomLimits(ZoomLimitModes mode, double min, double max)
Parameters
Type Name Description
ZoomLimitModes mode
System.Double min
System.Double max

SetZoomX(Int32, Int32, Double)

Declaration
public virtual void SetZoomX(int x, int y, double zoom)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Double zoom

ShowAnnotation(PTAnnot)

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

ShowRect(Int32, PTPDFRect)

Declaration
public virtual bool ShowRect(int page_num, PTPDFRect rect)
Parameters
Type Name Description
System.Int32 page_num
PTPDFRect rect
Returns
Type Description
System.Boolean

SmartZoomX(Double, Double, Boolean)

Declaration
public virtual bool SmartZoomX(double in_x, double in_y, bool animated)
Parameters
Type Name Description
System.Double in_x
System.Double in_y
System.Boolean animated
Returns
Type Description
System.Boolean

SnapToNearestInDoc(PTPDFPoint)

Declaration
public virtual PTPDFPoint SnapToNearestInDoc(PTPDFPoint screen_pt)
Parameters
Type Name Description
PTPDFPoint screen_pt
Returns
Type Description
PTPDFPoint

TakeUndoSnapshot(String)

Declaration
public virtual void TakeUndoSnapshot(string meta_info)
Parameters
Type Name Description
System.String meta_info

Undo()

Declaration
public virtual string Undo()
Returns
Type Description
System.String

Update()

Declaration
public virtual void Update()

Update(Boolean)

Declaration
public virtual void Update(bool all)
Parameters
Type Name Description
System.Boolean all

UpdateOCGContext()

Declaration
public virtual void UpdateOCGContext()

UpdatePageLayout()

Declaration
public virtual void UpdatePageLayout()

UpdateWithAnnot(PTAnnot, Int32)

Declaration
public virtual void UpdateWithAnnot(PTAnnot annot, int page_num)
Parameters
Type Name Description
PTAnnot annot
System.Int32 page_num

UpdateWithField(PTField)

Declaration
public virtual void UpdateWithField(PTField field)
Parameters
Type Name Description
PTField field

UpdateWithRect(PTPDFRect)

Declaration
public virtual void UpdateWithRect(PTPDFRect update)
Parameters
Type Name Description
PTPDFRect update

ZoomToRect(CGRect, Boolean)

Declaration
public virtual void ZoomToRect(CGRect rect, bool animated)
Parameters
Type Name Description
CoreGraphics.CGRect rect
System.Boolean animated

Events

DownloadError

Declaration
public event EventHandler<DownloadErrorEventArgs> DownloadError
Event Type
Type Description
System.EventHandler<DownloadErrorEventArgs>

DownloadEventType

Declaration
public event EventHandler<DownloadEventTypeEventArgs> DownloadEventType
Event Type
Type Description
System.EventHandler<DownloadEventTypeEventArgs>

GotThumbAsync

Declaration
public event EventHandler<GotThumbAsyncEventArgs> GotThumbAsync
Event Type
Type Description
System.EventHandler<GotThumbAsyncEventArgs>

JavascriptCallback

Declaration
public event EventHandler<JavascriptCallbackEventArgs> JavascriptCallback
Event Type
Type Description
System.EventHandler<JavascriptCallbackEventArgs>

OnSetDoc

Declaration
public event EventHandler<OnSetDocEventArgs> OnSetDoc
Event Type
Type Description
System.EventHandler<OnSetDocEventArgs>

OuterScrollViewDidEndDecelerating

Declaration
public event EventHandler<OuterScrollViewDidEndDeceleratingEventArgs> OuterScrollViewDidEndDecelerating
Event Type
Type Description
System.EventHandler<OuterScrollViewDidEndDeceleratingEventArgs>

OuterScrollViewDidEndDragging

Declaration
public event EventHandler<OuterScrollViewDidEndDraggingEventArgs> OuterScrollViewDidEndDragging
Event Type
Type Description
System.EventHandler<OuterScrollViewDidEndDraggingEventArgs>

OuterScrollViewDidEndScrollingAnimation

Declaration
public event EventHandler<OuterScrollViewDidEndScrollingAnimationEventArgs> OuterScrollViewDidEndScrollingAnimation
Event Type
Type Description
System.EventHandler<OuterScrollViewDidEndScrollingAnimationEventArgs>

OuterScrollViewDidEndZooming

Declaration
public event EventHandler<OuterScrollViewDidEndZoomingEventArgs> OuterScrollViewDidEndZooming
Event Type
Type Description
System.EventHandler<OuterScrollViewDidEndZoomingEventArgs>

OuterScrollViewDidScroll

Declaration
public event EventHandler<OuterScrollViewDidScrollEventArgs> OuterScrollViewDidScroll
Event Type
Type Description
System.EventHandler<OuterScrollViewDidScrollEventArgs>

OuterScrollViewDidScrollToTop

Declaration
public event EventHandler<OuterScrollViewDidScrollToTopEventArgs> OuterScrollViewDidScrollToTop
Event Type
Type Description
System.EventHandler<OuterScrollViewDidScrollToTopEventArgs>

OuterScrollViewDidZoom

Declaration
public event EventHandler<OuterScrollViewDidZoomEventArgs> OuterScrollViewDidZoom
Event Type
Type Description
System.EventHandler<OuterScrollViewDidZoomEventArgs>

OuterScrollViewWillBeginDecelerating

Declaration
public event EventHandler<OuterScrollViewWillBeginDeceleratingEventArgs> OuterScrollViewWillBeginDecelerating
Event Type
Type Description
System.EventHandler<OuterScrollViewWillBeginDeceleratingEventArgs>

OuterScrollViewWillBeginDragging

Declaration
public event EventHandler<OuterScrollViewWillBeginDraggingEventArgs> OuterScrollViewWillBeginDragging
Event Type
Type Description
System.EventHandler<OuterScrollViewWillBeginDraggingEventArgs>

OuterScrollViewWillBeginZooming

Declaration
public event EventHandler<OuterScrollViewWillBeginZoomingEventArgs> OuterScrollViewWillBeginZooming
Event Type
Type Description
System.EventHandler<OuterScrollViewWillBeginZoomingEventArgs>

PageNumberChangedFrom

Declaration
public event EventHandler<PageNumberChangedFromEventArgs> PageNumberChangedFrom
Event Type
Type Description
System.EventHandler<PageNumberChangedFromEventArgs>

PdfScrollViewDidEndDecelerating

Declaration
public event EventHandler<PdfScrollViewDidEndDeceleratingEventArgs> PdfScrollViewDidEndDecelerating
Event Type
Type Description
System.EventHandler<PdfScrollViewDidEndDeceleratingEventArgs>

PdfScrollViewDidEndDragging

Declaration
public event EventHandler<PdfScrollViewDidEndDraggingEventArgs> PdfScrollViewDidEndDragging
Event Type
Type Description
System.EventHandler<PdfScrollViewDidEndDraggingEventArgs>

PdfScrollViewDidEndScrollingAnimation

Declaration
public event EventHandler<PdfScrollViewDidEndScrollingAnimationEventArgs> PdfScrollViewDidEndScrollingAnimation
Event Type
Type Description
System.EventHandler<PdfScrollViewDidEndScrollingAnimationEventArgs>

PdfScrollViewDidEndZooming

Declaration
public event EventHandler<PdfScrollViewDidEndZoomingEventArgs> PdfScrollViewDidEndZooming
Event Type
Type Description
System.EventHandler<PdfScrollViewDidEndZoomingEventArgs>

PdfScrollViewDidScroll

Declaration
public event EventHandler<PdfScrollViewDidScrollEventArgs> PdfScrollViewDidScroll
Event Type
Type Description
System.EventHandler<PdfScrollViewDidScrollEventArgs>

PdfScrollViewDidScrollToTop

Declaration
public event EventHandler<PdfScrollViewDidScrollToTopEventArgs> PdfScrollViewDidScrollToTop
Event Type
Type Description
System.EventHandler<PdfScrollViewDidScrollToTopEventArgs>

PdfScrollViewDidZoom

Declaration
public event EventHandler<PdfScrollViewDidZoomEventArgs> PdfScrollViewDidZoom
Event Type
Type Description
System.EventHandler<PdfScrollViewDidZoomEventArgs>

PdfScrollViewDoubleTap

Declaration
public event EventHandler<PdfScrollViewDoubleTapEventArgs> PdfScrollViewDoubleTap
Event Type
Type Description
System.EventHandler<PdfScrollViewDoubleTapEventArgs>

PdfScrollViewLongPress

Declaration
public event EventHandler<PdfScrollViewLongPressEventArgs> PdfScrollViewLongPress
Event Type
Type Description
System.EventHandler<PdfScrollViewLongPressEventArgs>

PdfScrollViewTap

Declaration
public event EventHandler<PdfScrollViewTapEventArgs> PdfScrollViewTap
Event Type
Type Description
System.EventHandler<PdfScrollViewTapEventArgs>

PdfScrollViewWillBeginDecelerating

Declaration
public event EventHandler<PdfScrollViewWillBeginDeceleratingEventArgs> PdfScrollViewWillBeginDecelerating
Event Type
Type Description
System.EventHandler<PdfScrollViewWillBeginDeceleratingEventArgs>

PdfScrollViewWillBeginDragging

Declaration
public event EventHandler<PdfScrollViewWillBeginDraggingEventArgs> PdfScrollViewWillBeginDragging
Event Type
Type Description
System.EventHandler<PdfScrollViewWillBeginDraggingEventArgs>

PdfScrollViewWillBeginZooming

Declaration
public event EventHandler<PdfScrollViewWillBeginZoomingEventArgs> PdfScrollViewWillBeginZooming
Event Type
Type Description
System.EventHandler<PdfScrollViewWillBeginZoomingEventArgs>

PdfViewCtrlOnLayoutChanged

Declaration
public event EventHandler PdfViewCtrlOnLayoutChanged
Event Type
Type Description
System.EventHandler

PdfViewCtrlOnRenderFinished

Declaration
public event EventHandler PdfViewCtrlOnRenderFinished
Event Type
Type Description
System.EventHandler

PdfViewCtrlTextSearchStart

Declaration
public event EventHandler PdfViewCtrlTextSearchStart
Event Type
Type Description
System.EventHandler

TextSearchResult

Declaration
public event EventHandler<TextSearchResultEventArgs> TextSearchResult
Event Type
Type Description
System.EventHandler<TextSearchResultEventArgs>

Implements

UIKit.IUIGestureRecognizerDelegate
ObjCRuntime.INativeObject
System.IDisposable
UIKit.IUIPrintInteractionControllerDelegate
UIKit.IUIScrollViewDelegate

Extension Methods

PTPDFViewCtrl_Locking.DocLock(PTPDFViewCtrl, Boolean, Action<PTPDFViewCtrl>)
PTPDFViewCtrl_Locking.DocLock(PTPDFViewCtrl, Boolean, Action<PTPDFDoc>, out NSError)
PTPDFViewCtrl_Locking.DocLockReadWithBlock(PTPDFViewCtrl, Action<PTPDFViewCtrl>)
PTPDFViewCtrl_Locking.DocLockReadWithBlock(PTPDFViewCtrl, Action<PTPDFDoc>, out NSError)
Back to top Generated by DocFX