Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

CAbstractPDFTextToSpeechSynthesis	An abstract class that provides template methods to simplify the implementation of custom speech synthesizers
CAction	PDF action object
CActionCallback	An interface represents a action callback class for performing PDF actions. Users can implement only part of the callbacks according to actual requirements
CActivatable	Defines methods for activatable objects. The activatable object need to override its methods to implement the activation and deactivation operations
CActivationGroup	ActivationGroup 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!
CAdaptiveAppearance	Automatically select different appearance based on the current device type
CAddImageController
CAddMarkedStateCollaborationData	Describes the data format of add marked state collaboration action
CAddMarkedStateOperationData	Describes the details of add marked state operation
CAddReplyCollaborationData	Describes the data format of add reply collaboration action
CAddReplyOperationData	Describes the detail of add reply
CAddReviewStateCollaborationData	Describes the data format of add review state collaboration action
CAddReviewStateOperationData	Describes the details of add review state operation
CAlertOptions	An interface represents all options of alert callback
CAnnot	PDF annot object
CAnnotationAuthorityManager	Annotation 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
CAnnotationPermission	Describes the annotation permission informations
CAnnotComponent	You can use the ViewerAnnotManager::registerMatchRule to reset their default behavior
CAnnotFlag	Class with a flag number used to detect permissions
CAnnotOperationController	It'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
CAnnotRender	PDF annot render
CAnnotTooltip	Defines methods for annotation objects. The AnnotTooltip object need to override its methods to implement the show and hide operations
CAppearance	An 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
CButtonComponent	Defines 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>
CButtonComponentOptions	An interface that describes all configuration options of a button component
CCancelCreatingMeasurementController
CCaret	Caret annot object
CCircle	Circle annot object
CCollaborationCommunicator	An 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
CCollaborationData	The format of all built-in collaboration data and user-customize data
CCollaborationDataHandler	A collaboration data handler used to process collaboration data received from server
CCollaborationSessionInfo	An interface defines the session info including shareId and the parameters to open PDF file
CCommentCardComponent	Defines 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
CCommentListCardComponent	Defined as the super class of CommentCarComponent and ReplyCardComponent, encapsulationed same behaviors of them. CommentListCardComponent
CComparePageRange	Range of pages for comparison
CCompleteCreatingMeasurementController
CComponent	PDFUI 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
CComponentOptions	An interface that describes all basic configuration options of a component
CContainerComponent	An 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:
CContextMenuComponent	Defines 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>
CContextMenuItemComponent	Defines 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>
CContextMenuSeparatorComponent	Defines 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
CControllerDirective
CCopyAnnotTextController
CCreateAnnotAddon	Annotation creates the add-on entry
CCreateAnnotationCollaborationData	Describe the collaboration data format of create annotation action
CCreateAnnotationOperationData	The data used to create annotation that includes annotation information and page index
CCreateAnnotationService	This 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
CCreateFreeTextCalloutService	This 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
CDevicePoint	The DevicePoint interface is the point information defined in px, and DevicePoint {x:0,y:0} is in the left-top corner
CDeviceRect	DeviceRect is a definition of a rectangular range in units of physical pixels of the device. Point (0,0) is at the left-top conner
CDivScrollWrap	A basic class to create custom ScrollWrap with specified element. I'm going to rename it from CustomScrollWrap to DivScrollWrap
CDocTextSearch	This class can construct text search in a PDF document
CDownloadFileController
CDownloadFileService	A service to download files
CDropdownButtonComponent	Defines <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
CDropdownComponent	Defines <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
CDropdownComponentOptions	An interface describes all configuration options of dropdown component
CDropdownItemComponent	Defines <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
CFileAttachment	FileAttachment annot object
CFileSelectorComponent	Defines 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>
CFontMap	PDF page range object
CForeachDirective
CFormFieldComponent	Defined a form field type component
CFormFieldComponentOptions	An interface describes all basic configuration options of a form-field type component
CFormGroupComponent	<form-group> component, it used to control the display of form itemsExamples:
CFragmentComponentOptions	Component options in fragment config property
CFreeText	Free text annot object
CGlyphs	Font glyphs object
CGoToAction	GoTo action object
CGotoFirstPageController
CGotoLastPageController
CGotoNextPageController
CGotoPageController
CGotoPrevPageController
CGraphicsObject
CGroupComponent	Defines <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
CGroupComponentOptions	An interface describes all configuration options of a group component
CGroupListComponent	Defines <group-list> component. Group list is a container of <group>
CGTabComponent	Defines <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
CHeaderFooter	PDF HeaderFooter object
CHideAction	Hide action object
CHighlight	Highlight annot object
CIAnnotationSummary	Basic annotation summary
CICaretAnnotationSummary	Summaries of caret type annotation
CICircleAnnotationSummary	Summaries of circle type annotation
CIContextMenu	This 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.
CIContextMenuItem	This 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
CIFileAttachmentAnnotationSummary	Summaries of file attachment type annotation
CIFloatingTooltip	An abstract class used to implement floating box components displayed after text selection or other operations
CIFreeTextAnnotationSummary	Summaries of freetext type annotation
CIFreeTextCalloutAnnotationSummary	Summaries of callout type annotation
CIFreeTextTextBoxAnnotationSummary	Summaries of text box type annotation
CIFreeTextTypewriterAnnotationSummary	Summaries of typewriter type annotation
CIHighlightAnnotationSummary	Summaries of highlight annotation
CIInkAnnotationSummary	Summaries of ink annotation
CILayerNode	Describes the PDF layer node
CILineAnnotationSummary	Summaries of line annotation
CILinkAnnotationSummary	Summaries of link annotation
CImageObject
CIMarkupAnnotationSummary	Summaries of markup type annotations
CImportAnnotationsFileCollaborationData	An interface describes the collaboration data format of import annotation fdf,xfdf files
CImportAnnotationsFileOperationData	The data used to import annotations that includes base64 format data of the fdf, xfdf file
CInk	Ink annot object
CInlineColorPickerComponent	Defines an inline color picker component Example: <form-group label="Select Color"> <inline-color-picker></inline-color-picker> </form-group>
CINoteAnnotationSummary	Summaries of Note annotation
CIPolygonAnnotationSummary	Summaries of polygon annotation
CIPolylineAnnotationSummary	Summaries of polyline annotation
CIPopupAnnotationSummary	Popup annotation summary
CIRedactAnnotationSummary	Summaries of redact annotation
CISquareAnnotationSummary	Summaries of square annotation
CISquigglyAnnotationSummary	Summaries of squiggly annotation
CIStateHandler	Interface of StateHandler
CIStrikeoutAnnotationSummary	Summaries of squiggly annotation
CITextMarkupAnnotationSummary	Summaries of text markup type annotation
CIUnderlineAnnotationSummary	Summaries of underline annotation
CIViewerUI	This 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 } })
CIViewMode	Layout of page view interface
CJavaScriptAction	JavaScript action object
CLayerComponent	Defines <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
CLayerComponentOptions	An interface describes all configuration options of layer component
CLayerHeaderComponent	Defines 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
CLayerHeaderComponentOptions	An interface describes all configuration options of layer component
CLayerToolbarComponent	Defines <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
CLayerViewComponent	Defines <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
CLine	Line annot object
CLink	Link annot object
CLoupeController
CMarkup	Markup annot object
CMarkupAnnotComponent	Markup annot component
CMarqueeToolController
CMatrix	PDF matrix for coordinate transformation
CMediaDownloadController
CMediaPauseController
CMediaPlayController
CMobileAppearance	Appearance for mobile-end
CModular	Modular is an singleton class, you can access that instance by UIExtension.modular
CMoveAnnotsBetweenPageCollaborationData	Describes the data format used to collaborate the moving annotation action
CMoveAnnotsBetweenPageOperationData	Describes the the fromPageIndex, toPageIndex and annotation's data for move annotation operation
CNote	Note annot object
CNumberComponent	Defines 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
CNumberComponentOptions	An interface describes all configuration options of number component
COpenFileParameter	Parameters to open file
COpenLocalFileController
COpenRemoteFileController
COperationValues	The marking color(in 0xRRGGBB format) of each compare type objects
COptionGroupComponent	OptionGroupItem multiple: multiple choice selected: default choice Example: <option-group multiple> <option-group-item selected>i18n.key</option-group-item> </option-group>
CPaddleComponent	Defines 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>
CPageRange	PDF page range object
CPageViewDropdownComponent
CPathObject
CPDFBookmark
CPDFControl
CPDFDictionary
CPDFDoc
CPDFDocRender	The class that controls PDF document rendering
CPDFDocRendering
CPDFField
CPDFForm
CPDFPage
CPDFPageRender	PDF page renderer
CPDFPageRendering
CPDFPoint	The 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
CPDFRect	PDFRect is a definition of a rectangular range in units of point. Point (0,0) is at the left-bottom conner
CPDFSignature
CPDFTextToSpeechSynthesis	The interface of the speech synthesizer. You need to implement all the methods and properties declared below when customizing the speech synthesizer
CPDFTextToSpeechSynthesisTemplate	Template methods to simplify the implementation of custom speech synthesizers
CPDFTextToSpeechUtterance	The 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
CPDFViewer	Use PDFViewCtrl for the entry file
CPDFViewerRendering
CPolygon	Polygon annot object
CPolyLine	PolyLine annot object
CPPOInsertPageCollaborationData	Describes the format of ppo insert page collaboration action
CPPOInsertPageOperationData	Describes the information for PPO_INSERT_PAGE action
CPPOMovePageCollaborationData	Describes the collabroation data format of move page action
CPPOMovePageOperationData	Describes the format of ppo move page collaboration action
CPPORemovePageCollaborationData	Describes the format of ppo remove page collaboration action
CPPORemovePageOperationData	Describes which pageIndex need be removed
CPPORemovePagesCollaborationData	Describes the format of ppo remove page collaboration action
CPPORemovePagesOperationData	Describe the page range that needs to be removed
CPPORotatePageCollaborationData	Describes the format of ppo roate page collaboration action
CPPORotatePageOperationData	Describes the detail of rotate page operation
CPreConfiguredComponent	It's a simple & pre-configured high-order component
CPrintProgressBar	An interface class represents a progress bar
CReadAloudOptions	Interface describing the options of the speech synthesizer, including volume, rate, etc
CReadAloudService	Read aloud feature service
CReadAloudTextInformation	Defines an interface for text content page number and text rectangle boundary information
CRedact	Redact annot object
CRemoveAnnotationCollaborationData	Describes the data format used to collaborate remove annotation action
CRemoveAnnotationOperationData	Describes the data format for remove annotation
CRemoveReplyCollaborationData	Describes the data format of remove reply collaboration action
CRemoveReplyOperationData	Describes the details of remove reply operation
CReplyCardComponent	Defines a reply card component.ReplyCardComponent
CResetFormAction	ResetForm action object
CRibbonAppearance	Appearance for PC
CScreen	Screen annot object
CSelectTextAnnotationController
CSeniorComponentFactory	Factory class used to create high-order components
CSeniorComponentSuperclassOptions	An interface describes configuration options to generate a senior component superclass
CShowActionsController
CShowAnnotFormPropertiesController
CShowAnnotPropertiesController
CShowAnnotReplyController
CShowRedactPlaceDialogController
CShowSearchPanelController
CSidebarComponent	Defines sidebar component, It offers the following features:
CSidebarPanelComponentOptions	An interface describe all configuiration options of a sidebar-panel component
CSignPropertyController
CSinglePageModeController
CSlotComponent	Defines 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>
CSnapshotServer	Custom screenshot image storage service
CSound
CSquare	Square annot object
CSquiggly	Squiggly annot object
CStamp	Stamp annot object
CStampStateHandlerParams	An interface represents the parameter of STATE_HANDLER_CREATE_STAMP
CStatefulController	This 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 { constructor(component) { super(component, MyStateHandlerClass); } }
CStateHandlerManager
CStrikeOut	StrikeOut annot object
CTabItemComponent	Defines tab component. Tab is one of the view of a tabs component which used to accommodate any child components
CTabItemComponentOptions	An interface describes all configuration options of a tab component
CTabsComponent	Defines <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
CTaskProgress	The TaskProgress interface defines a process manager
CTaskProgressData	The TaskProgressData interface which defines the data in the progress of the task
CTextComponent	Defines 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
CTextMarkup	Text markup annotation object which contains Highlight, StrikeOut, Squiggly, Underline
CTextObject
CTextSearchMatch	The match result of text search
CTextSelectionTool	This 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}
CToolbarComponent	Defines 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
CTooltipLayerComponent	A tooltip like layer. Here is an example about usage on text-selection: /examples/UIExtension/customize-text-selection-tool/index.html
CTotalPageTextController
CTypingInkSignImageGenerator	An 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
CUIAppearance	An 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
CUIFragmentOptions	An interface describe configuration options of UI fragment
CUIXAddon	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
CUIXModule	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. An example for registering component class and usage:
CUnderline	Underline annot object
CUnit	Unit object
CUpdateAnnotationCollaborationData	Describes the data format for update annotation action
CUpdateAnnotationOperationData	The data used to update annotations
CUpdateAnnotContentCollaborationData	Describe the data format of update annotation content collaboration action
CUpdateAnnotContentOperationData	Describes the details of update annotation content operation
CURIAction	URI action object
CUserCustomizeCollaborationData	The format of user cusomize collaboration data
CUserPermission	Assist in determining the permissions of the User_Permissions
CViewerAnnotManager	Viewer Annot Manager. The behavior of the default annot can be reset by registerMatchRule
CViewModeController	It is an abstract template class for the view mode switching controllers
CViewModeManager	View Mode Manager The default contains the following two viewmode continuous-view-mode: Continuous page mode single-page-view-mode: Single page mode
CWebSocketCommunicator	Collaboration implementation based on native WebSocket API. For compatibility information, please refer to this link: Can i use websocket
CWidget	Widget annot
CXViewerUI	This 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) { // ... } } } })