Foxit PDF SDK for HarmonyOS  3.0
uiextensions Namespace Reference

Foxit uiextensions namespace. More...

Classes

class  DocumentManager
 
class  IAnnotationPermission
 
class  IAnnotationsPermission
 
class  IAnnotEventListener
 
class  IAnnotHandler
 
class  IDocModifiedEventListener
 
class  IExtensionsEventListener
 
class  IExtensionsGestureEventListener
 
class  IFlattenEventListener
 
class  IFullscreenStateListener
 
class  IGroupEventListener
 
class  IImportAnnotsEventListener
 
class  IInteractionEventListener
 
class  ILinkEventListener
 
class  IMainFrame
 
class  IModule
 
class  ISheetEventListener
 
class  IToolHandler
 
class  IToolHandlerChangedListener
 
class  IUIExtensionsManager
 
class  IUndoEventListener
 
class  IValueSettingsChangedListener
 
class  IViewSettingsManager
 
class  IXFAPageEventListener
 
class  IXFAWidgetEventListener
 
class  IXFAWidgetHandler
 
struct  UIExtensionsComponent
 
class  UIExtensionsManager
 

Enumerations

enum  BOTTOM_TOOL_BAR_ITEM { LIST = 115, VIEW, THUMBNAIL = "Thumbnail Module", BOOKMARK = "Bookmark Module" }
 
enum  FULL_SCREEN_TOOL_BAR_ITEM { PAGE_NAVIGATION = 200, TOOL, BOOKMARK = "Bookmark Module", MORE }
 
enum  MODULE_NAME {
  MODULE_NAME_LOCAL = "Local Module", DEFAULT = "Default", NOTE = "Note Module", TEXT_MARKUP = "TextMarkup Module",
  LINK = "Link Module", SHAPE = "Shape Module", TYPEWRITER = "Typewriter Module", TEXTBOX = "Textbox Module",
  CALLOUT = "Callout Module", CARET = "Caret Module", INK = "Ink Module", ERASER = "Eraser Module",
  STAMP = "Stamp Module", LINE = "Line Module", POLYGON = "Polygon Module", POLYLINE = "PolyLine Module",
  FILEATTACHMENT = "FileAttachment Module", IMAGE = "PDFImage Module", MEDIA = "Multimedia Module", SOUND = "Sound Module",
  REDACT = "Redact Module", DYNAMIC_XFA = "Dynamic XFA Module", SELECT_ANNOTATIONS = "Select Annotations Module", FILE_PANEL = "FileAttachment List Module",
  ANNOT_PANEL = "Annotations Panel Module", BOOKMARK = "Bookmark Module", OUTLINE = "Outline Module", DIGITAL_SIGNATURE = "Digital Signature Module",
  SIGNATURE_PANEL = "Signature Panel Module", SIGNATURE = "Signature Module", FORM_FILLER = "FormFiller Module", FORM_NAVIGATION = "Navigation Module",
  SEARCH = "Search Module", MODULE_MORE_MENU = "More Menu Module", DOCINFO = "DocumentInfo Module", THUMBNAIL = "Thumbnail Module",
  REFLOW = "Reflow Module", CROP = "Crop Module", COMPARISON = "Comparison Module", SELECTION = "TextSelect Module",
  CUSTOM_TOOLBAR = "Custom toolbar", PAGE_NAV = "Page Navigation Module", FIllSIGN = "FillSign Module", UNDO = "Undo Redo Module",
  PASSWORD = "Password Module", PANZOOM = "Pan Zoom Module", TTS = "TTS Module", AUTO_FLIP = "Auto Flip Module"
}
 
enum  PageColorMode { Day, Night, Custom }
 
enum  SIGNATURE_VIEW_TOP_BAR_ITEM { LEFT_BACK = 100, CENTER_TITLE, RIGHT_SAVE }
 
enum  TOOL_HANDLER_TYPE {
  UNKNOW = "UnKnow Tool", TEXTSELECT = "TextSelect Tool", BLANKSELECT = "BlankSelect Tool", AREAHIGHLIGHT = "AreaHighlight Tool",
  HIGHLIGHT = "Highlight Tool", UNDERLINE = "Underline Tool", STRIKEOUT = "Strikeout Tool", SQUIGGLY = "Squiggly Tool",
  NOTE = "Note Module", CIRCLE = "Circle Tool", SQUARE = "Square Tool", TYPEWRITER = "Typewriter Module",
  TEXTBOX = "Textbox Module", INSERTTEXT = "InsetText Tool", CALLOUT = "Callout Module", REPLACE = "Replace Tool",
  INK = "Ink Module", ERASER = "Eraser Module", STAMP = "Stamp Module", LINE = "Line Module",
  ARROW = "Arrow Tool", DISTANCE = "Distance Tool", FORM_FILLER = "FormFiller Module", FILEATTACHMENT = "FileAttachment Module",
  SIGNATURE = "Signature Module", PDFIMAGE = "PDFImage Tool", SCREEN_MEDIA = "AV Tool", POLYGON = "Polygon Module",
  POLYGONCLOUD = "polygon cloud Tool", POLYLINE = "PolyLine Module", SELECT_ANNOTATIONS = "Select Annotations Module", REDACT = "Redact Module",
  FILLSIGN = "FillSign Tool", LINK = "Link Module"
}
 
enum  TOP_TOOL_ATTACH_BAR_FEATURE_ITEM {
  Unknown = 0, AddTool, Redo, Undo,
  Property, MultiSelect, Divide, Pan,
  Adjust
}
 
enum  TOP_TOOL_ATTACH_BAR_ITEM {
  Text = 100, Image, Audio, Video,
  Link, Note = 200, Attachments, Stamp,
  Typewriter, Textbox, Callout, Highlight,
  Underline, Squiggly, Strikeout, ReplaceText,
  InsertText, AreaHighlight, Measure, ImageAnnotation,
  Pencil = 300, Highlighter, Eraser, Square,
  Oval, Line, Arrow, Polygon,
  PolyLine, Cloud, TextField = 400, CheckBox,
  RadioButton, ComboBox, ListBox, SignatureField,
  ImageField, FillSignText = 500, FillSignSegText, FillSignProfile,
  FillSignCheckMark, FillSignCrossMark, FillSignDot, FillSignLine,
  FillSignRoundRectangle, DigitalSignature = 600, Redact, PassWord,
  TrustedCertificates, RMS, AIP
}
 
enum  TOP_TOOL_BAR_ITEM {
  BACK = 109, PANEL, THUMBNAIL = "Thumbnail Module", BOOKMARK = "Bookmark Module",
  SEARCH = "Search Module", MORE
}
 
enum  TOP_TOOL_BAR_TAB {
  HOME = 111, EDIT, COMMENT, DRAWING,
  VIEW, FORM, FILLSIGN = "FillSign Tool", PROTECT,
  ESIGN
}
 
enum  ViewSettingsSheetType { PageColor }
 
enum  ViewSettingsType {
  SinglePage = 1000, FacingPage, CoverPage, Day,
  CustomPageColor, Night, ContinuousPage, FitPage,
  FitWidth, Reflow, Crop, TTS = "TTS Module",
  AutoFlip, RotateView, PanZoom, RTL
}
 

Detailed Description

Foxit uiextensions namespace.

Enumeration Type Documentation

◆ BOTTOM_TOOL_BAR_ITEM

Enumerator
LIST 

列表视图

VIEW 

视图控制模块

视图切换

THUMBNAIL 

缩略图模块(页面管理功能)

缩略图视图

缩略图集

BOOKMARK 

书签模块(管理自定义书签)

书签管理

书签导航

书签定位

◆ FULL_SCREEN_TOOL_BAR_ITEM

Enumerator
PAGE_NAVIGATION 

页面导航

TOOL 

工具切换

BOOKMARK 

书签模块(管理自定义书签)

书签管理

书签导航

书签定位

MORE 

更多操作

扩展菜单

◆ MODULE_NAME

Enumerator
MODULE_NAME_LOCAL 

本地文件管理模块(提供PDF文件列表视图及管理)

DEFAULT 

默认批注模块

NOTE 

便签批注模块

便签批注工具

TEXT_MARKUP 

文本标记批注模块

LINK 

超链接批注模块

超链接工具

SHAPE 

矩形批注模块

TYPEWRITER 

打字机批注模块

打字机工具

TEXTBOX 

文本框批注模块

文本框工具

CALLOUT 

标注框批注模块

标注工具

CARET 

插入符批注模块

INK 

手写批注模块

手写笔工具

ERASER 

橡皮擦模块

橡皮擦工具

STAMP 

图章批注模块

图章工具

LINE 

直线批注模块

直线工具

POLYGON 

多边形批注模块

多边形工具

POLYLINE 

多段线批注模块

多段线工具

FILEATTACHMENT 

文件附件批注模块

文件附件工具

IMAGE 

PDF图像批注模块

MEDIA 

多媒体批注模块

SOUND 

音频批注模块

REDACT 

密文批注模块

修订工具

DYNAMIC_XFA 

动态XFA模块

SELECT_ANNOTATIONS 

多选批注模块

多选批注工具

FILE_PANEL 

文件附件列表模块(展示文档内所有文件附件)

ANNOT_PANEL 

批注面板模块(列出PDF文档所有批注)

BOOKMARK 

书签模块(管理自定义书签)

书签管理

书签导航

书签定位

OUTLINE 

大纲模块(展示文档大纲树形结构)

DIGITAL_SIGNATURE 

数字签名模块(证书签名及验证)

SIGNATURE_PANEL 

签名面板模块

SIGNATURE 

Module name: Signature module

签名工具

FORM_FILLER 

表单填充模块(支持导出/导入表单数据)

表单填充工具

FORM_NAVIGATION 

表单导航模块(快速定位表单域)

SEARCH 

搜索模块(全文检索功能)

内容搜索

MODULE_MORE_MENU 

更多菜单模块, 包含一些无法归档的模块, 比如加密,另存为等

DOCINFO 

文档信息模块(显示元数据)

THUMBNAIL 

缩略图模块(页面管理功能)

缩略图视图

缩略图集

REFLOW 

页面重排模块(自适应移动端显示)

CROP 

裁剪模块(优化页面显示边界)

COMPARISON 

对比模块(PDF文件差异比对)

SELECTION 

文本选择模块, 在没有选中工具的情况下,长按文本,可以操作文本

CUSTOM_TOOLBAR 

工具条中一些通用的自定义工具模块

PAGE_NAV 

页面导航模块,用于在PDF页面之间导航

FIllSIGN 

填写签名模块

UNDO 

撤销重做模块

PASSWORD 

密码安全模块

PANZOOM 

画中画模块

TTS 

文本转语音模块

文本转语音

AUTO_FLIP 

自动翻页模块

◆ PageColorMode

Enumerator
Day 

日间模式

日间模式 注意:平板设备中日间与夜间模式视为同一项, 隐藏日间模式时夜间模式ViewSettingsType.Night也会同时隐藏,反之亦然

Night 

夜间模式

夜间模式 注意:平板设备中日间与夜间模式视为同一项, 隐藏夜间模式时日间模式ViewSettingsType.Day也会同时隐藏,反之亦然

Custom 

自定义色彩模式

◆ SIGNATURE_VIEW_TOP_BAR_ITEM

Enumerator
LEFT_BACK 

左侧返回按钮

CENTER_TITLE 

居中标题显示

RIGHT_SAVE 

右侧保存操作

◆ TOOL_HANDLER_TYPE

Enumerator
UNKNOW 

没有工具

TEXTSELECT 

文本选择工具

BLANKSELECT 

空白区域选择工具(用于添加批注或签名)

AREAHIGHLIGHT 

区域高亮工具

HIGHLIGHT 

高亮批注工具

UNDERLINE 

下划线批注工具

STRIKEOUT 

删除线批注工具

SQUIGGLY 

波浪线批注工具

NOTE 

便签批注模块

便签批注工具

CIRCLE 

圆形批注工具

SQUARE 

矩形批注工具

TYPEWRITER 

打字机批注模块

打字机工具

TEXTBOX 

文本框批注模块

文本框工具

INSERTTEXT 

插入文本工具

CALLOUT 

标注框批注模块

标注工具

REPLACE 

文本替换工具

INK 

手写批注模块

手写笔工具

ERASER 

橡皮擦模块

橡皮擦工具

STAMP 

图章批注模块

图章工具

LINE 

直线批注模块

直线工具

ARROW 

箭头工具

DISTANCE 

距离测量工具

FORM_FILLER 

表单填充模块(支持导出/导入表单数据)

表单填充工具

FILEATTACHMENT 

文件附件批注模块

文件附件工具

SIGNATURE 

Module name: Signature module

签名工具

PDFIMAGE 

PDF图像工具

SCREEN_MEDIA 

音视频工具

POLYGON 

多边形批注模块

多边形工具

POLYGONCLOUD 

云多边形工具

POLYLINE 

多段线批注模块

多段线工具

SELECT_ANNOTATIONS 

多选批注模块

多选批注工具

REDACT 

密文批注模块

修订工具

FILLSIGN 

填充签名工具

填写签署模块

LINK 

超链接批注模块

超链接工具

◆ TOP_TOOL_ATTACH_BAR_FEATURE_ITEM

Enumerator
Unknown 

未知操作项

AddTool 

新增工具项

Redo 

重做操作项

Undo 

撤销操作项

Property 

属性设置项

MultiSelect 

多选操作项

Divide 

分割操作项

Pan 

平移操作项

Adjust 

调整操作项

◆ TOP_TOOL_ATTACH_BAR_ITEM

Enumerator
Text 

文本工具设置

Image 

图像工具设置

Audio 

音频工具设置

Video 

视频工具设置

Link 

链接工具设置

Note 

笔记工具设置

Attachments 

附件管理设置

Stamp 

图章工具设置

Typewriter 

打字机工具

Textbox 

文本框工具

Callout 

标注框工具

Highlight 

高亮批注

Underline 

下划线工具

Squiggly 

波浪线工具

Strikeout 

删除线工具

ReplaceText 

文本替换工具

InsertText 

文本插入工具

AreaHighlight 

区域高亮工具

Measure 

测量工具

ImageAnnotation 

图像标注工具

Pencil 

铅笔工具

Highlighter 

荧光笔工具

Eraser 

橡皮擦工具

Square 

矩形工具

Oval 

椭圆工具

Line 

直线工具

Arrow 

箭头工具

Polygon 

多边形工具

PolyLine 

折线工具

Cloud 

云标注工具

TextField 

文本域工具

CheckBox 

复选框工具

RadioButton 

单选按钮工具

ComboBox 

组合框工具

ListBox 

列表框工具

SignatureField 

签名域工具

ImageField 

图像域工具

FillSignText 

签署文本工具

FillSignSegText 

分段签署工具

FillSignProfile 

配置文件签署

FillSignCheckMark 

勾选标记工具

FillSignCrossMark 

叉号标记工具

FillSignDot 

圆点标记工具

FillSignLine 

线条标记工具

FillSignRoundRectangle 

圆角矩形工具

DigitalSignature 

数字签名工具

Redact 

密文工具

PassWord 

密码保护设置

TrustedCertificates 

可信证书管理

RMS 

权限管理系统

AIP 

信息保护工具

◆ TOP_TOOL_BAR_ITEM

Enumerator
BACK 

返回操作

PANEL 

面板控制

THUMBNAIL 

缩略图模块(页面管理功能)

缩略图视图

缩略图集

BOOKMARK 

书签模块(管理自定义书签)

书签管理

书签导航

书签定位

SEARCH 

搜索模块(全文检索功能)

内容搜索

MORE 

更多操作

扩展菜单

◆ TOP_TOOL_BAR_TAB

Enumerator
HOME 

首页功能模块

EDIT 

编辑功能模块

COMMENT 

批注功能模块

DRAWING 

绘图工具模块

VIEW 

视图控制模块

视图切换

FORM 

表单处理模块

FILLSIGN 

填充签名工具

填写签署模块

PROTECT 

文档保护模块

ESIGN 

电子签名模块

◆ ViewSettingsSheetType

Enumerator
PageColor 

页面色彩设置弹窗

◆ ViewSettingsType

Enumerator
SinglePage 

单页视图模式

FacingPage 

对开页模式

CoverPage 

封面模式

Day 

日间模式

日间模式 注意:平板设备中日间与夜间模式视为同一项, 隐藏日间模式时夜间模式ViewSettingsType.Night也会同时隐藏,反之亦然

CustomPageColor 

自定义页面颜色

Night 

夜间模式

夜间模式 注意:平板设备中日间与夜间模式视为同一项, 隐藏夜间模式时日间模式ViewSettingsType.Day也会同时隐藏,反之亦然

ContinuousPage 

连续页面模式

FitPage 

适应页面

FitWidth 

适应宽度

Reflow 

重排模式

Crop 

裁剪模式

TTS 

文本转语音模块

文本转语音

AutoFlip 

自动翻页

RotateView 

旋转视图

PanZoom 

平移缩放

RTL 

从右到左布局