主题
PDF 组件页面操作相关 API
目录显示隐藏
ActivePDF.DocumentMap
控制目录的显示隐藏
语法
表达式.ActivePDF.DocumentMap = Boolean
表达式:文档类型应用对象
赋值 Boolean
为 true
显示目录,为 false
隐藏目录
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 控制目录的显示隐藏
app.ActivePDF.DocumentMap = true;
}
导出
ActivePDF.ExportAsFixedFormat()
导出文件为图片
语法
表达式.ActivePDF.ExportAsFixedFormat({ FixedFormatType })
表达式:文档类型应用对象
参数
属性 | 数据类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
FixedFormatType | Enum | 0 | 可选 | 导出的类型,详细可参考 Enum.FixedFormatType,目前仅支持导出图片 |
Print | Boolean | false | 可选 | 是否直接打开 |
ImgFormat | Enum | 0 | 可选 | 导出图片的格式,详细可参考 Enum.ExportImgFormatType |
Dpi | Number | 96 | 可选 | 图片质量 |
Combine2LongPic | Boolean | false | 可选 | 是否导出长图 |
RangeType | Enum | 0 | 可选 | 导出范围,详细可参考 Enum.RangeType |
WaterMark | Boolean | false | 可选 | 是否含水印 |
From | Boolean | 当前页 | 可选 | 起始页 |
To | Boolean | 当前页 | 可选 | 结束页 |
返回值
返回打印的 url
属性 | 数据类型 | 说明 |
---|---|---|
url | string | 打印的 url |
示例:导出图片
//@file=base.pptx
async function example() {
await instance.ready();
const app = instance.Application;
// 导出文件为图片
const imgUrl = await app.ActivePDF.ExportAsFixedFormat({
FixedFormatType: app.Enum.FixedFormatType.TypeIMG,
});
console.log(imgUrl);
}
登录操作者信息
ActivePDF.GetOperatorsInfo()
获取登录操作者信息
语法
表达式.ActivePDF.GetOperatorsInfo()
表达式:文档类型应用对象
返回值
Object object
属性 | 数据类型 | 说明 |
---|---|---|
type | String | 请求类型 |
response | Object | 用户信息列表 |
response 结构
属性 | 数据类型 | 说明 |
---|---|---|
id | String | 用户 id |
avatar_url | Object | 用户头像 |
logined | Object | 用户登录状态 |
name | Object | 用户姓名 |
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 获取登录操作者信息
const operatorsInfo = await app.ActivePDF.GetOperatorsInfo();
console.log(operatorsInfo);
}
页面坐标
ActivePDF.GetPointPageInfoByWinPoint()
JSSDK:v1.1.12+、WebOffice v3.2.1+ 支持
通过相对窗口页面的坐标获取原始PDF页面的坐标和页码
语法
表达式.ActivePDF.GetPointPageInfoByWinPoint(x, y)
表达式:文档类型应用对象
参数
属性 | 数据类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
x | Number | 是 | 相对窗口页面的x坐标 | |
y | Number | 是 | 相对窗口页面的y坐标 |
返回值
Object object
属性 | 数据类型 | 说明 |
---|---|---|
inContentRange | Boolean | 传入坐标是否在PDF正文区域(值为false代表不在正文区域,此时不会有其他的属性) |
pageIndex | Number | 传入坐标对应原始PDF的所在页的页码 |
x | Number | 传入坐标对应原始PDF页面的x坐标 |
y | Number | 传入坐标对应原始PDF页面的y坐标 |
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 通过相对窗口的坐标,获取到对应的点在原始页面的坐标和页码
const pointPageInfo = await app.ActivePDF.GetPointPageInfoByWinPoint(500,500);
console.log(pointPageInfo);
}
页面高度
ActivePDF.GetPageHeight()
JSSDK:v1.1.12+、WebOffice v3.2.1+ 支持
通过页码获取指定页面高度
语法
表达式.ActivePDF.GetPageHeight(PageIndex)
表达式:文档类型应用对象
参数
属性 | 数据类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
PageIndex | Number | 无 | 是 | 页码(索引从1开始) |
返回值
返回Number
表示指定页码页面的高度。
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 获取指定页码页面的高度,索引从1开始
const pageHeight = await app.ActivePDF.GetPageHeight(1);
console.log(pageHeight);
}
页面渲染模式
ActivePDF.PageMode
分页/连页模式切换
语法
表达式.ActivePDF.PageMode = Number
表达式:文档类型应用对象
设置 Number
值为 1 表示单页模式,设置为 0 表示多页模式。
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 单页/多页模式切换
app.ActivePDF.PageMode = 1;
}
页面宽度
ActivePDF.GetPageWidth()
JSSDK:v1.1.12+、WebOffice v3.2.1+ 支持
通过页码获取指定页面宽度
语法
表达式.ActivePDF.GetPageWidth(PageIndex)
表达式:文档类型应用对象
参数
属性 | 数据类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
PageIndex | Number | 无 | 是 | 页码(索引从1开始) |
返回值
返回Number
表示指定页码页面的宽度。
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 获取指定页码页面的宽度,索引从1开始
const pageWidth = await app.ActivePDF.GetPageWidth(1);
console.log(pageWidth);
}
保存
ActivePDF.Save()
JSSDK: v1.1.9+、WebOffice v2.3.1+ 支持
保存文件的改动
语法
表达式.ActivePDF.Save()
表达式:文档类型应用对象
返回值
属性 | 数据类型 | 说明 |
---|---|---|
result | String | 保存状态 |
size | Number | 文件大小,单位 byte |
version | Number | 版本 |
保存状态说明:
保存状态 | 说明 |
---|---|
ok | 版本保存成功,可在历史版本中查看 |
nochange | 文档无更新,无需保存版本 |
SavedEmptyFile | 暂不支持保存空文件 触发场景:内核保存完后文件为空 |
SpaceFull | 空间已满 |
QueneFull | 保存中请勿频繁操作 触发场景:服务端处理保存队列已满,正在排队 |
fail | 保存失败 |
示例
//@file=base.pdf
async function example() {
await instance.ready();
const app = instance.Application;
// 保存文件的改动
const saveResult = await app.ActivePDF.Save();
console.log(saveResult);
}