FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 CAdaptiveAppearanceAutomatically select different appearance based on the current device type
 CAnnotPDF annot object
 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
 CButtonComponentDefines button component,for more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/button.html Example:
 CButtonComponentOptionsAn interface that describes all configuration options of a button component
 CCaretCaret annot object
 CCircleCircle annot object
 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. @abstractCommentListCardComponent
 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:
 CContextMenuItemComponentDefines the <contextmenu-item> component. Example:
 CContextMenuSeparatorComponentDefines contextmenu separator component. Example:
 CController
 CControllerDirective
 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
 CDocTextSearchThis class can construct text search in a PDF document
 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> or . 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
 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:
 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
 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>
 CHighlightHighlight annot object
 CInkInk annot object
 CIStateHandlerInterface of StateHandler
 CIViewModeLayout of page view interface
 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
 CMarkupMarkup annot object
 CMobileAppearanceAppearance for mobile-end
 CModularModular is an singleton class, you can access that instance by UIExtension.modular
 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
 CPageViewDropdownComponent
 CPDFBookmark
 CPDFDoc
 CPDFDocRenderThe class that controls PDF document rendering
 CPDFDocRendering
 CPDFField
 CPDFForm
 CPDFPage
 CPDFPageRenderPDF page renderer
 CPDFPageRendering
 CPDFRectPDFRect is a definition of a rectangular range in units of point. Point (0,0) is at the left-bottom conner
 CPDFUI
 CPDFViewerUse PDFViewCtrl for the entry file
 CPDFViewerRendering
 CPolygonPolygon annot object
 CPolyLinePolyLine annot object
 CRedactRedact annot object
 CReplyCardComponentDefines a reply card component.ReplyCardComponent
 CRibbonAppearanceAppearance for PC
 CScreenScreen annot object
 CScrollWrapScroll bar container component
Controls the scrolling of a pdfviewer view
 CSeniorComponentSuperclassOptionsAn interface describes configuration options to generate a senior component superclass
 CSidebarComponentDefines sidebar component, It offers the following features:
 CSidebarPanelComponentOptionsAn interface describe all configuiration options of a sidebar-panel component
 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:
 CSnapshotServer
 CSound
 CSquareSquare annot object
 CSquigglySquiggly annot object
 CStampStamp annot object
 CStatefulControllerThis Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening
 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
 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
 CTextMarkupText markup annotation object which contains Highlight, StrikeOut, Squiggly, Underline
 CTextSearchMatchThe match result of text search
 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
 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
 CUnderlineUnderline annot object
 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

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