| ▼CAnnot | PDF annot object |
| CLink | Link annot object |
| ►CMarkup | Markup annot object |
| CCaret | Caret annot object |
| CCircle | Circle annot object |
| CCircle | Circle annot object |
| CFileAttachment | FileAttachment annot object |
| CFreeText | Free text annot object |
| CFreeText | Free text annot object |
| CHighlight | Highlight annot object |
| CInk | Ink annot object |
| CInk | Ink annot object |
| CLine | Line annot object |
| CLine | Line annot object |
| CNote | Note annot object |
| CPolygon | Polygon annot object |
| CPolygon | Polygon annot object |
| CPolyLine | PolyLine annot object |
| CPolyLine | PolyLine annot object |
| CRedact | Redact annot object |
| CSound | |
| CSound | |
| CSquare | Square annot object |
| CSquare | Square annot object |
| CSquiggly | Squiggly annot object |
| CStamp | Stamp annot object |
| CStrikeOut | StrikeOut annot object |
| ►CTextMarkup | Text markup annotation object which contains Highlight, StrikeOut, Squiggly, Underline |
| CHighlight | Highlight annot object |
| CSquiggly | Squiggly annot object |
| CStrikeOut | StrikeOut annot object |
| CUnderline | Underline annot object |
| CUnderline | Underline annot object |
| CScreen | Screen annot object |
| CAnnotRender | PDF annot render |
| ▼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 |
| CAdaptiveAppearance | Automatically select different appearance based on the current device type |
| CMobileAppearance | Appearance for mobile-end |
| CRibbonAppearance | Appearance for PC |
| ▼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 |
| ►CButtonComponent | Defines button component,for more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/button.html Example: |
| CContextMenuItemComponent | Defines the <contextmenu-item> component. Example: |
| 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: |
| ►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: |
| ►CCommentListCardComponent | Defined as the super class of CommentCarComponent and ReplyCardComponent, encapsulationed same behaviors of them. @abstractCommentListCardComponent |
| 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 |
| CReplyCardComponent | Defines a reply card component.ReplyCardComponent |
| ►CDropdownComponent | Defines <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 |
| CPageViewDropdownComponent | |
| CPageViewDropdownComponent | |
| 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 |
| 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 |
| CGroupListComponent | Defines <group-list> component. Group list is a container of <group> |
| ►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 |
| CContextMenuComponent | Defines contextmenu component. Example: |
| 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 |
| 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 |
| CSidebarComponent | Defines sidebar component, It offers the following features: |
| 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: |
| CTabItemComponent | Defines tab component. Tab is one of the view of a tabs component which used to accommodate any child components |
| 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 |
| 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 |
| CContextMenuSeparatorComponent | Defines contextmenu separator component. Example: |
| 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 |
| ►CFormFieldComponent | Defined a form field type component |
| 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 |
| 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 |
| 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 |
| ▼CComponentOptions | An interface that describes all basic configuration options of a component |
| CButtonComponentOptions | An interface that describes all configuration options of a button component |
| CDropdownComponentOptions | An interface describes all configuration options of dropdown component |
| ►CFormFieldComponentOptions | An interface describes all basic configuration options of a form-field type component |
| CNumberComponentOptions | An interface describes all configuration options of number component |
| CFragmentComponentOptions | Component options in fragment config property |
| CGroupComponentOptions | An interface describes all configuration options of a group component |
| CLayerComponentOptions | An interface describes all configuration options of layer component |
| CLayerHeaderComponentOptions | An interface describes all configuration options of layer component |
| CSidebarPanelComponentOptions | An interface describe all configuiration options of a sidebar-panel component |
| CTabItemComponentOptions | An interface describes all configuration options of a tab component |
| ▼CController | |
| CStatefulController | This Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening |
| CControllerDirective | |
| 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 |
| CDocTextSearch | This class can construct text search in a PDF document |
| CForeachDirective | |
| CIStateHandler | Interface of StateHandler |
| CIViewMode | Layout of page view interface |
| CModular | Modular is an singleton class, you can access that instance by UIExtension.modular |
| CPDFBookmark | |
| CPDFDoc | |
| CPDFDocRender | The class that controls PDF document rendering |
| CPDFDocRendering | |
| CPDFField | |
| CPDFForm | |
| CPDFPage | |
| CPDFPageRender | PDF page renderer |
| CPDFPageRendering | |
| CPDFRect | PDFRect is a definition of a rectangular range in units of point. Point (0,0) is at the left-bottom conner |
| ▼CPDFViewer | Use PDFViewCtrl for the entry file |
| CPDFUI | |
| CPDFViewerRendering | |
| CScrollWrap | Scroll bar container component
Controls the scrolling of a pdfviewer view
|
| CSeniorComponentSuperclassOptions | An interface describes configuration options to generate a senior component superclass |
| CSnapshotServer | |
| CStateHandlerManager | |
| CTextSearchMatch | The match result of text search |
| 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 |
| 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 |
| 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 |
| CViewModeManager | View Mode Manager |