FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
UIExtension

The namespace that creates Advanced PDF WebViewer instance, and inherits from the PDFViewer. More...

Modules

 components
 The namespace that includes all UI components.
 
 controllers
 The controllers module(namespace) contains some classes that inherit from Controller, you can access them like the following example:
 
 UIConsts
 UIConsts module is an Object, All current available constants of UIExtension module are mount to this object. You can access the constant like this examples in the following:
 
 appearances
 The namespace that contains supported UI themes across devices.
 

Classes

class  Modular
 Modular is an singleton class, you can access that instance by UIExtension.modular. More...
 
class  PDFUI
 
class  UIXAddon
 UIXAddon, an addon that relies on the UIExtension of Foxit PDF SDK for Web, is packaged separately into a JS file. The applications can load this addon as needed. This class defines the method templates what a UIXAddon needs to implement. More...
 
class  UIXModule
 A module constructed by Modular.module is collection of components and controllers. You can register a component class or a controller class into a module then you can use your component in template. More...
 

Enumerations

enum  UIEvents { ,
  fullscreenchange = 'fullscreenchange', appendCommentListComment = 'append-commentlist-comment', appendCommentListReply = 'append-commentlist-reply', destroyCommentListComment = 'destroy-commentlist-comment',
  destroyCommentListReply = 'destroy-commentlist-reply'
}
 The event enumerations of PDFUI. All event in this enumeration must be registered via PDFUI.addUIEventListener API. More...
 

Variables

import modular from modular
 

Detailed Description

The namespace that creates Advanced PDF WebViewer instance, and inherits from the PDFViewer.

Enumeration Type Documentation

◆ UIEvents

enum UIEvents

The event enumerations of PDFUI. All event in this enumeration must be registered via PDFUI.addUIEventListener API.

Enumerator
fullscreenchange 

Triggered after fulscreen state changed

@param isFullscreen {boolean} represents current viewport is or not in fullscreen mode
pdfui.addUIEventListener(UIExtension.UIEvents.fullscreenchange, function(isFullscreen) {
// do something here
})
appendCommentListComment 

Triggered after a comment card appended=

@param commentCardComponent CommentCardComponent
@param annot PDFJSCore.Markup
pdfui.addUIEventListener(UIExtension.UIEvents.appendCommentListComment, function(commentCardComponent, annot) {
// do something such as add a button into commentCardComponent
})
appendCommentListReply 

Triggered after a reply card appended into a comment card in left sidebar=

@param replyCardComponent ReplyCardComponent
@param annot PDFJSCore.Annot
pdfui.addUIEventListener(UIExtension.UIEvents.appendCommentListReply, function(replyCardComponent, annot) {
// do something such as add a button into replyComponent
})
destroyCommentListComment 

Triggered after a comment card in left sidebar has been destroyed=

@param commentCardComponent CommentCardComponent
@param annot PDFJSCore.Markup
pdfui.addUIEventListener(UIExtension.UIEvents.destroyCommentListComment, function(commentCardComponent, annot) {
// do something
})
destroyCommentListReply 

Triggered after a reply card in left sidebar has been destroyed=

@param replyCardComponent ReplyCardComponent
@param replyAnnot PDFJSCore.Annot
pdfui.addUIEventListener(UIExtension.UIEvents.destroyCommentListReply, function(replyCardComponent, replyAnnot){
// do something
})

Variable Documentation

◆ modular

Modular modular

This object is used to create and manage all UIXModule instances, You can use this instance like the following:

const module = UIExtension.modular.module('my-module', []); // Create new UIXModule
const getModule = UIExtension.modular.module('my-module');
See also
Modular
UIXModule

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