通过应用所需的配置信息创建应用, 其中包含必要的初始化信息。例如 id,它是插件的唯一标识符。
关闭当前活动文档。
关闭选项,默认值为:{promptToSave: true, showCancel: true}
如果成功关闭文档,返回 true,否则返回 false。
创建一个空白文档。
空白文档页面的宽度。
空白文档页面的高度。
空白文档。
获取当前应用程序的路径。
当前应用程序的路径。
获取当前应用的标题。
当前应用的标题。
通过指定索引获取文档。
文档的索引。该值可以通过 getDocsCount 进行遍历。
通过指定索引获取文档。
当前已打开的文档数量。
返回当前已打开的文档数量。
获取当前应用程序的名称。
获取应用程序的名称。它将是 "Foxit PhantomPDF" 或 "Foxit Reader"。
获取应用程序的功能区(Ribbon Bar)。
OptionalparentWnd: LPVOIDType功能区的父窗口。
返回应用程序的功能区对象。
获取当前应用程序的版本。
获取应用程序的版本。
获取任务窗格的显示状态。
加载图形对象插件。
从 URL 打开一个 PDF 文档。
await app.openFileFromUrl({
url: 'https://www.example.com/test.pdf',
password: '123456',
headers: {
'Authorization': 'Bearer 1234567890',
'cookie': 'name=value; name2=value2'
},
fileTransferCallbacks: {
onProgress: (clientData, progress) => {
console.log(`onProgress: ${progress}`);
},
onResult: (clientData, result, message) => {
console.log(`onResult: ${result}, ${message}`);
}
}
});
通过 OpenFromFileOptions 打开一个 PDF 文档。
打开 PDF 文档的选项。
将用户提供的事件处理程序注册到文档窗口上。
回调集合。当文档事件发生时,Reader 会调用对应的回调函数
TRUE 表示成功,否则表示失败。
注册上下文菜单。
追加右键菜单的类型名称。 例如:"Page"、"Annot"、"Select"
上下文菜单的菜单项。
如果成功注册上下文菜单,返回 true,否则返回 false。
const contextMenuAdditionJs = {
menuItems: [
{
index: 0,
icon: '',
title: 'menu1',
name: 'menu1',
tooltip: 'menu1',
describeText: 'menu1',
isSeparator: false,
executeProc: () => {
console.log('Execute proc');
},
isEnable: true
}
]}
await app.registerForContextMenuAddition('Page', contextMenuAdditionJs);
注册页面对象选择处理程序。
回调集合。当进行页面对象选择时,阅读器会调用对应的回调函数。
返回页面对象选择处理程序对象,可用于注销页面对象选择处理程序。
注册矩形工具处理程序。
回调集合。矩形绘制完成后,阅读器会调用对应的回调函数。
返回矩形工具处理对象,可用于注销该矩形工具处理程序。
const callbacks = {
onToolLButtonDown: (clientData, pageview, flags, point) => {
console.log('onToolLButtonDown', clientData, pageview, flags, point);
},
onToolLButtonUp: (clientData, pageview, flags, point) => {
console.log('onToolLButtonUp', clientData, pageview, flags, point);
}
};
const toolHandler = await app.registerRectangleHandler(callbacks);
注册一个选择处理程序。
回调集合。当进行选区操作时,阅读器会调用对应的回调函数。
返回选择处理程序对象,可用于注销该选择处理程序。
const callbacks = {
onToolLButtonDown: (clientData, pageview, flags, point) => {
console.log('onToolLButtonDown', clientData, pageview, flags, point);
},
onToolLButtonUp: (clientData, pageview, flags, point) => {
console.log('onToolLButtonUp', clientData, pageview, flags, point);
}
};
const toolHandler = await app.registerSelectionHandler(callbacks);
selectOpenFile 方法用于打开文件选择对话框,允许用户选择一个或多个文件。
文件过滤字符串,用于指定可见的文件类型。
指示是否允许多选文件。
返回一个 Promise,其解析值为字符串数组,表示所选文件的路径。
设置活动文档。它将显示在最前端。
要设置为活动状态的文档。
如果成功将文档设为活动状态,返回 true,否则返回 false。
通过索引设置当前活动文档。
文档的索引值。该值可以通过 getDocsCount 迭代获取。
如果成功将文档设置为活动文档,则返回 true,否则返回 false。
设置当前激活的工具。
要设置为激活状态的工具。
是否持久化该工具。默认为 false。
如果工具设置成功则返回 true,否则返回 false。
显示或隐藏任务窗格。
是否显示任务窗格。默认值为 true。
取消注册页面对象选择事件处理程序
页面对象选择事件处理程序,通常是 registerPageObjectSelectionHandler 返回的对象
返回取消注册的结果
取消注册矩形处理程序。
要取消注册的矩形处理程序,一般为 registerRectangleHandler 返回的对象。
如果矩形处理程序成功取消注册则返回 true,否则返回 false。
注销选择事件处理程序
选择事件处理程序,通常为 registerSelectionHandlerJs 返回的对象
返回注销结果
Staticcreate创建一个应用实例。
通过应用所需的配置信息创建应用, 其中包括必要的初始化信息。例如 id,它是插件的唯一标识符。
返回应用实例。
创建一个应用实例。 请使用 create 来创建实例,而不是通过 new 模式创建实例。