FoxitPDFSDKforWeb  8.2.0
Foxit PDF SDK for Web
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 CAbstractPDFTextToSpeechSynthesisAn abstract class that provides template methods to simplify the implementation of custom speech synthesizers
 CActionPDF action object
 CActionCallbackAn interface represents a action callback class for performing PDF actions. Users can implement only part of the callbacks according to actual requirements
 CActivatableDefines methods for activatable objects. The activatable object need to override its methods to implement the activation and deactivation operations
 CActivationGroupActivationGroup class is extended from Activatable and used to implement multiple activation operations. Example:

var activatable1 = pdfViewer.getAnnotRender(0, '<annotation id 1>').getComponent();
var activatable2 = pdfViewer.getAnnotRender(0, '<annotation id 2>').getComponent();
var activatable3 = pdfViewer.getAnnotRender(0, '<annotation id 3>').getComponent();
var group = new PDFViewCtrl.ActivationGroup();
group.add(activatable1);
group.add(activatable2);
pdfViewer.activateElement(group); // both activatable1 and activatable2 are going to be activated!
group.add(activatable3); // activatable3 will also be activated!
group.remove(activatable2); // activatable2 will be unactivated!
pdfViewer.deactivateElement(group) // All activatables in group are going to be unactivated!
 CAdaptiveAppearanceAutomatically select different appearance based on the current device type
 CAddImageController
 CAddMarkedStateCollaborationDataDescribes the data format of add marked state collaboration action
 CAddMarkedStateOperationDataDescribes the details of add marked state operation
 CAddReplyCollaborationDataDescribes the data format of add reply collaboration action
 CAddReplyOperationDataDescribes the detail of add reply
 CAddReviewStateCollaborationDataDescribes the data format of add review state collaboration action
 CAddReviewStateOperationDataDescribes the details of add review state operation
 CAlertOptionsAn interface represents all options of alert callback
 CAnnotPDF annot object
 CAnnotationAuthorityManagerAnnotation Authority manager class, It used to control the permission of each annotations in the PDF document. It can be obtained via Viewer.PDFViewer::getAnnotAuthorityManager() method
 CAnnotationPermissionDescribes the annotation permission informations
 CAnnotComponentYou can use the ViewerAnnotManager::registerMatchRule to reset their default behavior
 CAnnotFlagClass with a flag number used to detect permissions
 CAnnotOperationControllerIt's a abstract controller class provides an easy way for sub-controller classes to take control the contextmenu-item's visibility and usability before contextmenu shown
 CAnnotRenderPDF annot render
 CAppearanceAn appearance like a packed theme. It provides a layout template and also allows to do things related to UE in beforeMounted or afterMounted method. When the layout template is rewritten, it is best to inherit this class and override the disableAll and enableAll methods to handle associated logic
 CAppearanceTab
 CApplyAllRedactController
 CApplyRedactController
 CButtonComponentDefines button component,for more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/button.html Example:

<xbutton>i18n.key</xbutton>
<xbutton text="i18n.key"></xbutton>
<xbutton icon-class="icon-css-class-name">i18n.key</xbutton>
 CButtonComponentOptionsAn interface that describes all configuration options of a button component
 CCancelCreatingMeasurementController
 CCaretCaret annot object
 CCircleCircle annot object
 CCollaborationCommunicatorAn interface defines several methods that user should follow to implement custom CollaborationCommunicator. Collaboration communicator is used to process and generate collaboration sessions, synchronize collaboration data, send collaboration data, and receive collaboration data from other clients
 CCollaborationDataThe format of all built-in collaboration data and user-customize data
 CCollaborationDataHandlerA collaboration data handler used to process collaboration data received from server
 CCollaborationSessionInfoAn interface defines the session info including shareId and the parameters to open PDF file
 CCommentCardComponentDefines a comment card component in the comment list tab of the left sidebar. This component are created automatically after loading a PDF page or creating or importing annotations, and after creating this component instance, UIEvents.appendCommentListComment event is fired with the current instance and the annotation
 CCommentListCardComponentDefined as the super class of CommentCarComponent and ReplyCardComponent, encapsulationed same behaviors of them. CommentListCardComponent
 CCompleteCreatingMeasurementController
 CComponentPDFUI allows you to define a component as a class inherit from Component and register that into a module to provide UI features. Each component has several 'lifecycle methods' that you can override to run code at particular times in the process
 CComponentOptionsAn interface that describes all basic configuration options of a component
 CContainerComponentAn container is a component to organize widgets. You need to inherit this class and implement some necessary methods to customize your own container components.
The features that distinguish from widgets are following:
 CContextMenuComponentDefines contextmenu component. Example:

<contextmenu>
<contextmenu-item name="contextmenu-item-0">i18n.key0</contextmenu-item>
<contextmenu-separator></contextmenu-separator>
<contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item>
</contextmenu>
 CContextMenuItemComponentDefines the <contextmenu-item> component. Example:

<contextmenu>
<contextmenu-item name="contextmenu-item-0" icon-class="fv__icon-toolbar-fullscreen" shortcut="Ctrl+P">i18n.key0</contextmenu-item>
<contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item>
</contextmenu>
 CContextMenuSeparatorComponentDefines contextmenu separator component. Example:

<contextmenu>
<contextmenu-item name="contextmenu-item-0">i18n.key0</contextmenu-item>
<contextmenu-separator></contextmenu-separator>
<contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item>
</contextmenu>
 CContinuousFacingPageModeController
 CContinuousPageModeController
 CControllerController is a base class used to implement UI component business logic. It contains the entire life cycle process of UI components. In these lifecycle methods, you can implement style adjustments to UI components, event monitoring, and destruction. The Controller provides a special handle method. The triggering behavior of the handle is defined by the component itself. It is suitable for simple component event processing, such as the click event of the xbutton and the change event triggered after the file-selector selects a file; Controller provides a special method: handle, The triggering behavior of handle is defined by the component itself, for example: the <xbutton> triggers handle on mouse click and the <file-selector> triggers handle on change event. There's two ways to reference a Controller to a Component:
 CControllerDirective
 CCopyAnnotTextController
 CCreateAnnotAddonAnnotation creates the add-on entry
 CCreateAnnotationCollaborationDataDescribe the collaboration data format of create annotation action
 CCreateAnnotationOperationDataThe data used to create annotation that includes annotation information and page index
 CCreateAnnotationServiceThis is a service interface that defines the function of creating Annotation, and classes that create specific Annotations should inherit it
 CCreateAreaController
 CCreateAreaHighlightController
 CCreateArrowController
 CCreateCalloutController
 CCreateCaretController
 CCreateCircleAreaController
 CCreateCircleController
 CCreateDistanceController
 CCreateFileAttachmentController
 CCreateFreeTextCalloutServiceThis is a class that encapsulates the function of creating callout annotations. It is usually used to customize the state handler for creating callout annotations. It can easily implement the process of creating callouts without having to care about more details
 CCreateHighlightController
 CCreateImageController
 CCreateLineController
 CCreateLinkController
 CCreatePencilController
 CCreatePerimeterController
 CCreatePolygonCloudController
 CCreatePolygonController
 CCreatePolylineController
 CCreateReplaceController
 CCreateSquareController
 CCreateSquigglyController
 CCreateStrikeoutController
 CCreateTextboxController
 CCreateTextController
 CCreateTypewriterController
 CCreateUnderlineController
 CDeleteAnnotController
 CDevicePointThe DevicePoint interface is the point information defined in px, and DevicePoint {x:0,y:0} is in the left-top corner
 CDeviceRectDeviceRect is a definition of a rectangular range in units of physical pixels of the device. Point (0,0) is at the left-top conner
 CDivScrollWrapA basic class to create custom ScrollWrap with specified element.
I'm going to rename it from CustomScrollWrap to DivScrollWrap
 CDocTextSearchThis class can construct text search in a PDF document
 CDownloadFileController
 CDownloadFileServiceA service to download files
 CDropdownButtonComponentDefines <dropdown-button> component, Dropdown button must be an item in <dropdown>'s list, this component may act as a button or a file-selector, for more details please visit /examples/UIExtension/tutorials/widgets/dropdown.html
 CDropdownComponentDefines <dropdown> component. Dropdown is toggleable, contextual overlays for displaying lists of <dropdown-button>, <dropdown-item>, <xbutton>, <file-selector> or <li>. for more details please visit this example page: /examples/UIExtension/tutorials/widgets/dropdown.html
 CDropdownComponentOptionsAn interface describes all configuration options of dropdown component
 CDropdownItemComponentDefines <dropdown-item> component, dropdown item must be an item in the dropdown list. This component can wrapping any other component even dropdown also. For more details please visit /examples/UIExtension/tutorials/widgets/dropdown.html
 CFacingPageModeController
 CFileAttachmentFileAttachment annot object
 CFileSelectorComponentDefines file selector component. It looks the same as xbutton, a system file selector will popup after user clicks, and the change event will be triggered and handle method of controller will be invoked with file object after select a file. Example:

<file-selector accept=".pdf" icon-class="icon-css-class-name">i18n.key</file-selector>
 CFontMapPDF page range object
 CForeachDirective
 CFormFieldComponentDefined a form field type component
 CFormFieldComponentOptionsAn interface describes all basic configuration options of a form-field type component
 CFragmentComponentOptionsComponent options in fragment config property
 CFreeTextFree text annot object
 CGlyphsFont glyphs object
 CGoToActionGoTo action object
 CGotoFirstPageController
 CGotoLastPageController
 CGotoNextPageController
 CGotoPageController
 CGotoPrevPageController
 CGraphicsObject
 CGroupComponentDefines <group> component. When the browser width is adjusted to less than 600, this component will automatically shrink. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/group.html
 CGroupComponentOptionsAn interface describes all configuration options of a group component
 CGroupListComponentDefines <group-list> component. Group list is a container of <group>
 CGTabComponentDefines <gtab> component, GTab is a component used to switch serval views. Different from <tabs> component, <gtab> component's tab and tab-body are separated! This allows us to define tabs more flexibly!
 CHandController
 CHeaderFooterPDF HeaderFooter object
 CHideActionHide action object
 CHighlightHighlight annot object
 CIAnnotationSummaryBasic annotation summary
 CICaretAnnotationSummarySummaries of caret type annotation
 CICircleAnnotationSummarySummaries of circle type annotation
 CIContextMenuThis is an abstract contextmenu class. The various behaviors of the user-customized contextmenu can be encapsulated in its subclasses, and then its subclasses should be created in the XViewerUI::createContextMenu to complete the contextmenu customization.
 CIFileAttachmentAnnotationSummarySummaries of file attachment type annotation
 CIFloatingTooltipAn abstract class used to implement floating box components displayed after text selection or other operations
 CIFreeTextAnnotationSummarySummaries of freetext type annotation
 CIFreeTextCalloutAnnotationSummarySummaries of callout type annotation
 CIFreeTextTextBoxAnnotationSummarySummaries of text box type annotation
 CIFreeTextTypewriterAnnotationSummarySummaries of typewriter type annotation
 CIHighlightAnnotationSummarySummaries of highlight annotation
 CIInkAnnotationSummarySummaries of ink annotation
 CILayerNodeDescribes the PDF layer node
 CILineAnnotationSummarySummaries of line annotation
 CILinkAnnotationSummarySummaries of link annotation
 CImageObject
 CIMarkupAnnotationSummarySummaries of markup type annotations
 CImportAnnotationsFileCollaborationDataAn interface describes the collaboration data format of import annotation fdf,xfdf files
 CImportAnnotationsFileOperationDataThe data used to import annotations that includes base64 format data of the fdf, xfdf file
 CInkInk annot object
 CINoteAnnotationSummarySummaries of Note annotation
 CIPolygonAnnotationSummarySummaries of polygon annotation
 CIPolylineAnnotationSummarySummaries of polyline annotation
 CIPopupAnnotationSummaryPopup annotation summary
 CIRedactAnnotationSummarySummaries of redact annotation
 CISquareAnnotationSummarySummaries of square annotation
 CISquigglyAnnotationSummarySummaries of squiggly annotation
 CIStateHandlerInterface of StateHandler
 CIStrikeoutAnnotationSummarySummaries of squiggly annotation
 CITextMarkupAnnotationSummarySummaries of text markup type annotation
 CIUnderlineAnnotationSummarySummaries of underline annotation
 CIViewerUIThis class provides an ability for user to customize the several UI like contextmenu which may be triggered from PDFViewCtrl module, that stuffs should be customized like the example:

new PDFViewer({
...otherOptions,
viewerUI: class extends PDFViewCtrl.IViewerUI {
...implementations
}
})
 CIViewModeLayout of page view interface
 CJavaScriptActionJavaScript action object
 CLayerComponentDefines <layer> component. A layer component can be used to open a floating box above ather element and also can be used as a modal dialog with a optional backdrop. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
 CLayerComponentOptionsAn interface describes all configuration options of layer component
 CLayerHeaderComponentDefines layer-header component, usually used for the header of a dialog box. For more details on usage, please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
 CLayerHeaderComponentOptionsAn interface describes all configuration options of layer component
 CLayerToolbarComponentDefines <layer-toolbar> component. It should be used as the child of <layer> component. This component is usually used as a container of one-line buttons, and is often used as the bottom bar of a dialog box. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
 CLayerViewComponentDefines <layer-view> component. It should be used as the child of <layer> component. This component is usually used as a body container for dialog box. For more detail please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
 CLineLine annot object
 CLinkLink annot object
 CLoupeController
 CMarkupMarkup annot object
 CMarkupAnnotComponentMarkup annot component
 CMarqueeToolController
 CMatrixPDF matrix for coordinate transformation
 CMediaDownloadController
 CMediaPauseController
 CMediaPlayController
 CMobileAppearanceAppearance for mobile-end
 CModularModular is an singleton class, you can access that instance by UIExtension.modular
 CMoveAnnotsBetweenPageCollaborationDataDescribes the data format used to collaborate the moving annotation action
 CMoveAnnotsBetweenPageOperationDataDescribes the the fromPageIndex, toPageIndex and annotation's data for move annotation operation
 CNoteNote annot object
 CNumberComponentDefines number component, which is a text input element that allows only numbers and has a limited range and step size. For more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/number.html
 CNumberComponentOptionsAn interface describes all configuration options of number component
 COpenFileParameterParameters to open file
 COpenLocalFileController
 COpenRemoteFileController
 COptionGroupComponentOptionGroupItem multiple: multiple choice selected: default choice Example:

<option-group multiple>
<option-group-item selected>i18n.key</option-group-item>
</option-group>
 CPaddleComponentDefines paddle component, used to toggle content when content overflows to facilitate display of overflowing content.

<div class="container" style="width: 768px">
<paddle>
<div style="width: 1024px">content</div>
</paddle>
</div>
 CPageRangePDF page range object
 CPageViewDropdownComponent
 CPathObject
 CPDFBookmark
 CPDFControl
 CPDFDictionary
 CPDFDoc
 CPDFDocRenderThe class that controls PDF document rendering
 CPDFDocRendering
 CPDFField
 CPDFForm
 CPDFPage
 CPDFPageRenderPDF page renderer
 CPDFPageRendering
 CPDFPointThe PDFPoint interface is the point information defined in pt, and PDFPoint {x:0,y:0} is in the left-bottom corner of the PDF page
 CPDFRectPDFRect is a definition of a rectangular range in units of point. Point (0,0) is at the left-bottom conner
 CPDFSignature
 CPDFTextToSpeechSynthesisThe interface of the speech synthesizer. You need to implement all the methods and properties declared below when customizing the speech synthesizer
 CPDFTextToSpeechSynthesisTemplateTemplate methods to simplify the implementation of custom speech synthesizers
 CPDFTextToSpeechUtteranceThe PDFTextToSpeechUtterance represents a speech request, It contains a piece of text content and the page number of the text content in the PDF document, as well as other relevant information
 CPDFUI
 CPDFViewerUse PDFViewCtrl for the entry file
 CPDFViewerRendering
 CPolygonPolygon annot object
 CPolyLinePolyLine annot object
 CPPOInsertPageCollaborationDataDescribes the format of ppo insert page collaboration action
 CPPOInsertPageOperationDataDescribes the information for PPO_INSERT_PAGE action
 CPPOMovePageCollaborationDataDescribes the collabroation data format of move page action
 CPPOMovePageOperationDataDescribes the format of ppo move page collaboration action
 CPPORemovePageCollaborationDataDescribes the format of ppo remove page collaboration action
 CPPORemovePageOperationDataDesdcribes which pageIndex need be removed
 CPPORotatePageCollaborationDataDescribes the format of ppo roate page collaboration action
 CPPORotatePageOperationDataDescribes the detail of rotate page operation
 CPreConfiguredComponentIt's a simple & pre-configured high-order component
 CPrintProgressBarAn interface class represents a progress bar
 CReadAloudOptionsInterface describing the options of the speech synthesizer, including volume, rate, etc
 CReadAloudServiceRead aloud feature service
 CReadAloudTextInformationDefines an interface for text content page number and text rectangle boundary information
 CRedactRedact annot object
 CRemoveAnnotationCollaborationDataDescribes the data format used to collaborate remove annotation action
 CRemoveAnnotationOperationDataDescribes the data format for remove annotation
 CRemoveReplyCollaborationDataDescribes the data format of remove reply collaboration action
 CRemoveReplyOperationDataDescribes the details of remove reply operation
 CReplyCardComponentDefines a reply card component.ReplyCardComponent
 CResetFormActionResetForm action object
 CRibbonAppearanceAppearance for PC
 CScreenScreen annot object
 CScrollWrapScroll bar container component, Controls the scrolling of a pdfviewer view
 CSelectTextAnnotationController
 CSeniorComponentFactoryFactory class used to create high-order components
 CSeniorComponentSuperclassOptionsAn interface describes configuration options to generate a senior component superclass
 CShowActionsController
 CShowAnnotFormPropertiesController
 CShowAnnotPropertiesController
 CShowAnnotReplyController
 CShowRedactPlaceDialogController
 CShowSearchPanelController
 CSidebarComponentDefines sidebar component, It offers the following features:
 CSidebarPanelComponentOptionsAn interface describe all configuiration options of a sidebar-panel component
 CSignPropertyController
 CSinglePageModeController
 CSlotComponentDefines slot component, inherits from ContainerComponent. Slot can accommodate multile child components, and inserting that into the specified position of the target component after mounted to DOM tree. A slot component needs to specify the slot name and target component name, or if the target component name is not specified, then parent component instead. Example:

<webpdf>
<some-component name="any-component-name"></some-component>
<slot component="any-component-name" for="slot-name">
<i class="xxx"></i>
</slot>
<some-container-component>
<slot for="slot-name">
<i class="xxx"></i>
</slot>
</some-container-component>
</webpdf>
 CSnapshotServerCustom screenshot image storage service
 CSound
 CSquareSquare annot object
 CSquigglySquiggly annot object
 CStampStamp annot object
 CStampStateHandlerParamsAn interface represents the parameter of STATE_HANDLER_CREATE_STAMP
 CStatefulControllerThis Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening. A customization example:

class MyStateHandlerClass extends PDFViewCtrl.IStateHandler {
// ...
}
class MyStateController extends UIExtension.controllers.StatefulController {
super(component, MyStateHandlerClass);
}
}
 CStateHandlerManager
 CStrikeOutStrikeOut annot object
 CTabItemComponentDefines tab component. Tab is one of the view of a tabs component which used to accommodate any child components
 CTabItemComponentOptionsAn interface describes all configuration options of a tab component
 CTabsComponentDefines <tabs> component. Tabs is a component with a set of tabs used to switch different views. For more details on usage please visit this page /examples/UIExtension/tutorials/widgets/tabs.html
 CTaskProgressThe TaskProgress interface defines a process manager
 CTaskProgressDataThe TaskProgressData interface which defines the data in the progress of the task
 CTextComponentDefines text component. This component will localize text content via I18Next and generates an text node insert into the DOM tree, You can update content of that text node via TextComponent.setText() API. It acts like data-i18n attribute, but that clears all children elements. For more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/text.html
 CTextMarkupText markup annotation object which contains Highlight, StrikeOut, Squiggly, Underline
 CTextObject
 CTextSearchMatchThe match result of text search
 CTextSelectionToolThis class is used in text selection tools in <tooltip-layer>. For more details on usage please refer to this example: -examples{UIExtension/customize-text-selection-tool/index.html}
 CToolbarComponentDefines toolbar component. This is just an div with a css class name fv__ui-toolbar. Usually it's used to customize special styles of the component in the toolbar
 CTooltipLayerComponentA tooltip like layer. Here is an example about usage on text-selection: /examples/UIExtension/customize-text-selection-tool/index.html
 CTotalPageTextController
 CTypingInkSignImageGeneratorAn ink signature image generator that generates image data url from specific text content and font. This class provides importFontFamily API to import thirdparty fonts globally from remote what you needed
 CUIAppearanceAn appearance like a packed theme. It provides a layout template and also allows to do things related to UE in beforeMounted or afterMounted method. When the layout template is rewritten, it is best to inherit this class and override the disableAll and enableAll methods to handle associated logic
 CUIFragmentOptionsAn interface describe configuration options of UI fragment
 CUIXAddonUIXAddon, 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
 CUIXModuleA 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. An example for registering component class and usage:
 CUnderlineUnderline annot object
 CUnitUnit object
 CUpdateAnnotationCollaborationDataDescribes the data format for update annotation action
 CUpdateAnnotationOperationDataThe data used to update annotations
 CUpdateAnnotContentCollaborationDataDescribe the data format of update annotation content collaboration action
 CUpdateAnnotContentOperationDataDescribes the details of update annotation content operation
 CURIActionURI action object
 CUserCustomizeCollaborationDataThe format of user cusomize collaboration data
 CUserPermissionAssist in determining the permissions of the User_Permissions
 CViewerAnnotManagerViewer Annot Manager.
The behavior of the default annot can be reset by registerMatchRule
 CViewModeControllerIt is an abstract template class for the view mode switching controllers
 CViewModeManagerView Mode Manager
The default contains the following two viewmode
continuous-view-mode: Continuous page mode
single-page-view-mode: Single page mode
 CWebSocketCommunicatorCollaboration implementation based on native WebSocket API. For compatibility information, please refer to this link: Can i use websocket
 CWidgetWidget annot
 CXViewerUIThis class provides an ability for user to customize the several UI like contextmenu which may be triggered from PDFViewCtrl module. You should customize that stuffs like the following example:

new PDFUI({
viewerOptions: {
viewerUI: new class extends UIExtension.XViewerUI {
createContextMenu(owner, anchor, config) {
// ...
}
}
}
})

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