FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
PDFViewCtrl

The namespace that controls the drawing and rendering of PDF. PDF is used to modifying PDF data. More...

Modules

 renderers
 Please access these objects by getter functions of PDFViewer or other object instead of their constructors.
 
 stateHandler
 
 interfaces
 
 viewMode
 

Classes

class  PDFViewer
 Use PDFViewCtrl for the entry file. More...
 
class  UserPermission
 Assist in determining the permissions of the User_Permissions. More...
 

Enumerations

enum  ViewerEvents {
  jrLicenseSuccess = 'jr-license-success' , openFileSuccess = 'open-file-success', openFileFailed = 'open-file-failed', willCloseDocument ='will-close-document' ,
  renderPageSuccess = 'render-page-success' , zoomToSuccess = 'zoom-to-success', zoomToFailed = 'zoom-to-failed', startChangeViewMode = 'start-change-view-mode',
  changeViewModeSuccess = 'change-view-mode-success', changeViewModeFailed = 'change-view-mode-failed' , pageLayoutRedraw = 'page-layout-redraw' , copyTextSuccess = 'copy-text-success',
  copyTextFailed = 'copy-text-failed', tapPage = 'tap-page', tapAnnotation = 'tap-annotation', pressPage = 'press-page',
  pressAnnotation = 'press-annotation' , rightClickPage = 'right-click-page', rightClickAnnotation = 'right-click-annotation', doubleTapPage = 'double-tap-page',
  doubleTapAnnotation = 'double-tap-annotation', activeAnnotationBefore = 'active-annotation-before', activeAnnotation = 'active-annotation', activeAnnotationAfter = 'active-annotation-after' ,
  unActiveAnnotation = 'unactive-annotation', updateActionAnnotation = 'update-action-annotation', removeActionAnnotationBefore = 'remove-action-annotation-before', removeActionAnnotationSuccess = 'remove-action-annotation-success',
  removeActionAnnotationFailed = 'remove-action-annotation-failed', switchStateHandler = 'switch-state-handler' , pageNumberChange ='page-number-change'
}
 The event type of pdfViewer. Expand the DataEvents. More...
 

Detailed Description

The namespace that controls the drawing and rendering of PDF. PDF is used to modifying PDF data.

Enumeration Type Documentation

◆ ViewerEvents

The event type of pdfViewer. Expand the DataEvents.

See also
DataEvents
Enumerator
jrLicenseSuccess 

Jr engine certification successful

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.jrLicenseSuccess, () => {
//do something
})
}
openFileSuccess 

The document opens successfully, but the rendering is not necessarily complete

@param pdfDoc {PDFDoc}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.openFileSuccess, (pdfDoc) => {
//do something
})
}
openFileFailed 

Failed to open document

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.openFileFailed, () => {
//do something
})
willCloseDocument 

I'm going to close the document

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.willCloseDocument, () => {
//do something
})
renderPageSuccess 

Page rendered successfully

@param pageRender {PageRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.renderPageSuccess, (pageRender) => {
//do something
})
}
zoomToSuccess 

Scaling of success

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.zoomToSuccess, (newScale, oldScale) => {
//do something
})
}
zoomToFailed 

Scaling failure

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.zoomToFailed, (newScale, oldScale) => {
//do something
})
}
startChangeViewMode 

Start toggling view mode

@param newViewMode {IViewMode}
@param oldViewMode {IViewMode}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.startChangeViewMode, (newViewMode, oldViewMode) => {
//do something
})
}
changeViewModeSuccess 

Successfully switch view mode

@param newViewMode {IViewMode}
@param oldViewMode {IViewMode}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.changeViewModeSuccess, (newViewMode, oldViewMode) => {
//do something
})
}
changeViewModeFailed 

Failed to switch view mode

@param newViewMode {IViewMode}
@param oldViewMode {IViewMode}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.changeViewModeFailed, (newViewMode, oldViewMode) => {
//do something
})
}
pageLayoutRedraw 

Redraw the page layout

@param pageRender {PageRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.pageLayoutRedraw, (pageRender) => {
//do something
})
}
copyTextSuccess 

Copy text successful

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.copyTextSuccess, (text) => {
//do something
})
}
copyTextFailed 

Failed to copy text

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.copyTextFailed, (text) => {
//do something
})
}
tapPage 

Click on the page

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.tapPage, () => {
//do something
})
}
tapAnnotation 

Click the notation

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.tapAnnotation, (annotRender) => {
//do something
})
}
pressPage 

Long press page

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.pressPage, () => {
//do something
})
}
pressAnnotation 

Long press the notation

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.pressAnnotation, (annotRender) => {
//do something
})
}
rightClickPage 

Right-click the page

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.rightClickPage, () => {
//do something
})
}
rightClickAnnotation 

Right-click annotation

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.rightClickAnnotation, (annotRender) => {
//do something
})
}
doubleTapPage 

Double-click on the page

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.doubleTapPage, () => {
//do something
})
}
doubleTapAnnotation 

Double-click the annotation

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.doubleTapAnnotation, (annotRender) => {
//do something
})
}
activeAnnotationBefore 

Prepare to activate the annotation

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.activeAnnotationBefore, (annotRender) => {
//do something
})
}
activeAnnotation 

Activate the annotation to enter the edit state

@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.activeAnnotation, (annotRender) => {
//do something
})
}
activeAnnotationAfter 

Activate the annotation and enter the edit state

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.activeAnnotationAfter, () => {
//do something
})
}
unActiveAnnotation 
@param annotRender {AnnotRender}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.unActiveAnnotation, (annotRender) => {
//do something
});
}
updateActionAnnotation 

Update the active annotations

@param annotComponent {AnnotComponent}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.updateActionAnnotation, (annotComponent) => {
//do something
})
}
removeActionAnnotationBefore 

Delete the active annotation before

@param annotComponent {AnnotComponent}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.removeActionAnnotationBefore, (annotComponent) => {
//do something
})
}
removeActionAnnotationSuccess 

The active annotation was deleted successfully

@param annotComponent {AnnotComponent}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.removeActionAnnotationSuccess, (annotComponent) => {
//do something
})
}
removeActionAnnotationFailed 

Failed to delete active annotation

@param annotComponent {AnnotComponent}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.removeActionAnnotationFailed, (annotComponent) => {
//do something
})
}
switchStateHandler 

Switch stateHandler

@param newStateHandler {IStateHandler}
@param oldStateHandler {IStateHandler}
function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.switchStateHandler, (newStateHandler, oldStateHandler) => {
//do something
})
}
pageNumberChange 

The page number displayed has changed

function example (pdfViewer, ViewerEvents) {
pdfViewer.eventEmitter.on(ViewerEvents.pageNumberChange, (newPageNumber) => {
// newPageNumber = pageIndex + 1
})
}

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.