FoxitPDFSDKforWeb v10.0.0
Archives
    Foxit PDF SDK for Web
    Class Hierarchy
    This inheritance list is sorted roughly, but not completely, alphabetically:
    [detail level 1234]
     ►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
     CActionCallbackManagerAction callback manager class, It used to control customized action callbacks. It can be obtained via PDFViewer::getActionCallbackManager() method
     ►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!
     CAddBookmarkEventRepresents an event that occurs when a new bookmark is added
     CAddBookmarkOptionsRepresents options for adding a new bookmark
     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
     CAnnotationPermissionDescribes the annotation permission informations
     CAnnotComponentConfigAn interface that describes all available configuration properties of AnnotComponent
     CAnnotFlagClass with a flag number used to detect permissions
     CAnnotRenderPDF annot render
     CAnnotTooltipDefines methods for annotation objects. The AnnotTooltip object need to override its methods to implement the show and hide operations
     CAppearanceTab
     CBlendColorResolverOptionsOptions of BlendColorResolver callback
     CBookmarkDataRepresents a bookmark entry in the document
     CBookmarkDataServiceProvides functionality for management and manipulation of bookmark-related data
     CBookmarkDestinationRepresents information about the destination of a bookmark
     CBookmarkFontStyleRepresents the font style of a bookmark
     CBookmarkPropertiesRepresents properties of a bookmark
     CBookmarkUIServiceBookmark service for manipulating bookmark data at the UIExtension level. Different from BookmarkDataService, the BookmarkUIService also updates the UI and supports undo-redo
     ►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
     CColorClass for processing color-related algorithms such as conversions
     CCombinePixelsOptionsOptions to handle pixel-diff and combine-pixels algorithms
     CComparePageRangeRange of pages for comparison
     ►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
     CControllerDirective
     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
     CDeleteBookmarkEventRepresents an event that occurs when a bookmark is deleted
     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
     CDigitalStampSizeRepresents the size of a digital stamp
     CDigitalStampTemplateRepresents a custom digital stamp template
     ►CDisposable
     CDocTextSearchThis class can construct text search in a PDF document
     CDownloadFileServiceA service to download files
     CFileSpec
     CFindReplaceAddonProvides APIs to find or replace text in the PDF document
     CFontMapPDF page range object
     CForeachDirective
     CGlyphsFont glyphs object
     ►CGraphicsObject
     CHandStateHandlerConfig
     CHeaderFooterPDF HeaderFooter object
     ►CIAnnotationSummaryBasic annotation summary
     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.
     CIContextMenuItemThis is an abstract contextmenu-item class. The various behaviors of the user-customized contextmenu-item can be encapsulated in its subclasses, and then its subclasses should be obtained from IContextMenu::getItem by the name to complete the contextmenu customization
     CIdentityInfoRepresents identity information for digital stamps
     CILayerNodeDescribes the PDF layer node
     CImageDataImage data used for overlay comparison, which can be obtained through PDFPage.render or CanvasRenderingContext2D.getImageData or CanvasRenderingContext2D.createImageData
     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
     CInlineColorPickerComponentDefines an inline color picker component Example:

    <form-group label="Select Color">
    <inline-color-picker></inline-color-picker>
    </form-group>
     CIPopupAnnotationSummaryPopup annotation summary
     CISignatureUIInterface for the signature component
     CISignedSignaturePropertiesDialogInterface for displaying the information of verified signature
     CISignVerifiedResultDialogInterface for displaying the result of verifing signature
     CIStateHandlerInterface of StateHandler
     ►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
     CLineThicknessValuesThe line thickness of each compare type objects. By default, these values are 2 pt
     CLoggerFactoryThe LoggerFactory is a utility class producing Loggers for various logging APIs
     CMarkingColorValuesThe marking color(in 0xRRGGBB format) of each compare type objects
     CMatrixPDF matrix for coordinate transformation
     CModularModular is an singleton class, you can access that instance via 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
     CMoveBookmarkEventRepresents an event that occurs when a bookmark is moved
     CMultimediaPlayerAn interface represents the necessary methods of multimedia player. The MultimediaPlayer object need to override its methods to implement the operations
     COnProgressListenerRegister a callback that is used to get data when the progress is updated
     COpacityValuesThe opacity of each compare type objects. The opacity is expressed as a percentage, and the default is 100%
     COpenFileParameterParameters to open file
     COverlayComparisonOptionsOptions for OverlayComparisonService.compareImageData
     COverlayComparisonOptionsService
     COverlayComparisonServiceOverlay comparison function entry, this instance must be obtained through PDFViewer.getOverlayComparisonService method
     COverlayComparisonTransformationOptionsTransformation parameters of the target image data
     CPageEditorAddonProvides page edit functionality for document operations within the UIExtension
     ►CPageGraphicsObjectRepresents a graphics object within the PDF page
     ►CPageGraphicsObjectPropertiesDefines common editable properties for page editing objects
     CPageRangePDF page range object
     CPageTextSearchSearch result extractor
     CPasteCutBookmarkInfoParameter of the callback function triggered when pasting a cut bookmark
     CPDFControl
     CPDFDictionary
     CPDFDocRenderThe class that controls PDF document rendering
     CPDFDocRendering
     ►CPDFField
     CPDFForm
     CPDFPage
     CPDFPageBatchProcessorControls the start, flush, and end cycles of a batch processor, and calling property update methods within the batch processor declaration cycle can greatly improve performance
     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
     ►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
     CPDFViewerRendering
     CPDFViewPreference
     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
     CPPORemovePageOperationDataDescribes which pageIndex need be removed
     CPPORemovePagesCollaborationDataDescribes the format of ppo remove page collaboration action
     CPPORemovePagesOperationDataDescribe the page range that needs to 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
     CPreviewInterface
     CPrintUIXAddonRepresents the Print Addon in the UIExtension, allowing users to show a print dialog
     CProgressComponentThe ProgressComponent is an interface class that represents a component for displaying the progress of a task. It can be used to provide a visual indication of the progress of a task that may take some time to complete
     CProxy
     CReadAloudAddonRepresents the Read Aloud Addon in the PDFUI, allowing users to have documents read aloud
     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
     CRegisterPrintHandlerCallbackA callback function used to PDFViewer::registerPrintHandler
     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
     CSeniorComponentFactoryThe Factory class is used to create high-order components
     CSeniorComponentSuperclassOptionsAn interface describes configuration options to generate a senior component superclass
     CSignatureFlowOptionsAn interface that describes all configuration options of customize the signature flow
     CSignatureInfomationAn interface declaration containing information related to the signature
     CSimpleEventEmitter
     CSnapshotSnapshot information, including the PDFPageRender it belongs to, the selected area, and the image data stream
     CSnapshotInteractionThis is a built-in snapshot interaction class, and the application layer can inherit it to implement custom interaction logic
     CSnapshotServerCustom screenshot image storage service
     CStampInfoThis interface describes the stamp infomation
     CStampServiceA singleton class, which can be obtained via PDFUI.getStampService. It can be used to obtain the currently selected stamp icon and monitor the switching action between stamp icons
     CStampStateHandlerParamsAn interface represents the parameter of STATE_HANDLER_CREATE_STAMP
     CStateHandlerManager
     ►CStorageContextStores the context used to generate storage space names
     ►CStorageDriverRepresents a storage driver
     CStorageDriverChangeEvent< T >Represents an event triggered when there is a change in the storage driver. T The type of the old and new values in the storage change event
     CStorageDriverRemoveEventRepresents an event triggered when a stored value is removed in the storage driver
     CSubmitFormActionCallbackA callback function used to ActionCallbackManager::setSubmitFormCallback
     CTaskProgressThe TaskProgress interface defines a process manager
     CTaskProgress< T extends TaskProgressData >The TaskProgress interface which defines a process manager
     CTaskProgressDataThe TaskProgressData interface which defines the data in the progress of the task
     CTextSearchMatchThe match result of text search
     CTreeNodeDataRepresents the data structure for a tree node
     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
     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:
     CUndoRedoAddonThis addon provides comprehensive undo and redo operations at a global level within the document environment. It supports undoing and redoing actions related to bookmarks, annotations, and advanced editing (AdvEdit) functionalities. Users can efficiently revert or reapply changes made to bookmarks, annotations, and advanced editing tasks within the document, enhancing the overall control and flexibility of document management
     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
     CUpdateBookmarkPropertiesEventRepresents an event that occurs when bookmark properties are updated
     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
     CViewModeManagerView Mode Manager
    The default contains the following two viewmode
    continuous-view-mode: Continuous page mode
    single-page-view-mode: Single page mode
     CXFAWidgetInfoAn interface represents the information of widget

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