API for PDFNet SDK for Universal Windows Platform (UWP)
pdftron.PDF
PDFViewCtrl Class
PDFViewCtrl Methods
Activate Method
AllowScrollOnKeyPresses Method
CancelAllThumbRequests Method
CancelFindText Method
CancelRendering Method
CanRedo Method
CanUndo Method
ClearSelection Method
ClearThumbCache Method
Close Method
CloseDoc Method
ConnectDocAndResume Method
ConvAnnotationCanvasPtToScreenPt Method
ConvCanvasPtToPagePt Method
ConvCanvasPtToScreenPt Method
ConvPagePtToCanvasPt Method
ConvPagePtToScreenPt Method
ConvScreenPtToAnnotationCanvasPt Method
ConvScreenPtToCanvasPt Method
ConvScreenPtToPagePt Method
CopySelectedTextToClipboardAsUnicode Method
Deactivate Method
DocLock Method
DocLockRead Method
DocTryLock Method
DocTryLockRead Method
DocUnlock Method
DocUnlockRead Method
EnableExternalAnnotManager Method
EnableUndoRedo Method
ExecuteAction Method
FindTextAsync Method
FreeResources Method
GetAnnotAt Method
GetAnnotationCanvas Method
GetAnnotationCanvasHorizontalOffset Method
GetAnnotationCanvasTopLeftCorner Method
GetAnnotationCanvasVerticalOffset Method
GetAnnotationListAt Method
GetCanvasHeight Method
GetCanvasWidth Method
GetColorPostProcessMode Method
GetContentBoundingBox Method
GetCurrentPage Method
GetDeviceTransform Method
GetDoc Method
GetExternalAnnotManager Method
GetFindTextProgress Method
GetFindTextProgressAsFactor Method
GetHScrollPos Method
GetLinkAt Method
GetNextRedoInfo Method
GetNextUndoInfo Method
GetOCGContext Method
GetPageBox Method
GetPageCount Method
GetPageNumberFromScreenPoint Method
GetPagePresentationMode Method
GetPageRectForAnnot Method
GetPageRefViewMode Method
GetPageViewMode Method
GetPostProcessedColor Method
GetProgressiveRendering Method
GetRightToLeftLanguage Method
GetRotation Method
GetScreenRectForAnnot Method
GetScrollBarVisibility Method
GetScrollEnabled Method
GetScrollViewer Method
GetSelection Method
GetSelectionBeginPage Method
GetSelectionEndPage Method
GetThumbAsync Method
GetViewHeight Method
GetViewWidth Method
GetVisiblePages Method
GetVScrollPos Method
GetZoom Method
GetZoomAnimationTarget Method
GetZoomEnabled Method
GetZoomForViewMode Method
GotoFirstPage Method
GotoLastPage Method
GotoNextPage Method
GotoPreviousPage Method
HasSelection Method
HasSelectionOnPage Method
HideAnnotation Method
IsAnimatingZoom Method
IsFinishedRendering Method
OpenUniversalDocument Method
OpenURLAsync Method
PauseAndDisconnectDoc Method
Redo Method
RefreshAndUpdate Method
RegisterDependencyProperties Method
RequestRendering Method
RevertAllChanges Method
RotateClockwise Method
RotateCounterClockwise Method
Select Method
SelectAll Method
SelectWithSmartSnapping Method
SelectWithSnapping Method
SetAntiAliasing Method
SetBackgroundColor Method
SetCaching Method
SetColorPostProcessColors Method
SetColorPostProcessMode Method
SetCurrentPage Method
SetDefaultPageColor Method
SetDoc Method
SetDrawAnnotations Method
SetGamma Method
SetHighlightFields Method
SetHorizontalAlign Method
SetHScrollPos Method
SetImageSmoothing Method
SetOCGContext Method
SetOverprint Method
SetPageBorderVisibility Method
SetPageBox Method
SetPagePresentationMode Method
SetPageRefViewMode Method
SetPageSpacing Method
SetPageTransparencyGrid Method
SetPageViewMode Method
SetPathHinting Method
SetProgressiveRendering Method
SetProgressiveRenderingInterval Method
SetRelativeZoomLimits Method
SetRenderedContentCacheSize Method
SetRequiredFieldBorderColor Method
SetRightToLeftLanguage Method
SetScrollBarVisibility Method
SetScrollEnabled Method
SetSnappingMode Method
SetTextSelectionMode Method
SetThinLineAdjustment Method
SetupThumbnails Method
SetUrlExtraction Method
SetVerticalAlign Method
SetVScrollPos Method
SetZoom Method
SetZoomEnabled Method
SetZoomLimits Method
ShowAnnotation Method
ShowRect Method
SmartZoom Method
SnapToNearestInDoc Method
TakeSnapshot Method
Undo Method
Update Method
UpdateOCGContext Method
UpdatePageLayout Method
UpdateWithAnnot Method
Click or drag to resize

PDFViewCtrlDocLock Method

Locks the PDFDoc instance used by PDFViewCtrl. Simultaneous access to a PDFDoc instance is not allowed. Since PDFViewCtrl renders a PDFDoc in a rendering thread, UI access to the same PDFDOc instance should lock the document first and then unlock it with DocUnlock afterwards.

Namespace:  pdftron.PDF
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
Copy
public void DocLock(
	bool cancel_rendering
)

Parameters

cancel_rendering
Type: SystemBoolean
If true, rendering thread is canceled first before trying to lock the document. This ensures a quick return from this function. Otherwise, this function can halt the UI and the app may be unresponsive before the rendering thread finishes. If the rendering thread is canceled, unlocking the document DocUnlock will restart the rendering thread.
See Also