# 当前 PDF 实例(ActivePDF)

当前 PDF 实例对象

### 属性列表

|属性|说明|
|-|-|
|[CurrentPage](#currentpage)|获取当前页码|
|[DocumentMap](#documentmap)|控制目录的显示隐藏|
|[DragMode](#dragmode)|拖拽模式设置和获取|
|[PageMode](#pagemode)|分页/连页模式切换|
|[PagesCount](#pagescount)|获取总页数|
|[PlayMode](#playmode)|播放状态设置和获取|
|[ReadOnly](#readonly)|返回一个值，表示文档是否只读，此属性为只读属性。|
|[ReadOnlyComment](#readonlycomment)|返回一个值，表示文档是否只读可评论的权限，此属性为只读属性。|
|[Scroll](#scroll)|获取滚动位置|
|[ShowPages](#showpages)|获取可视区域内的所有页面索引|
|[ShowPagesTextData](#showpagestextdata)|获取可视区域内的所有页面的文本数据|
|[SupportReadOnlyComment](#supportreadonlycomment)|返回一个值，表示文档是否支持只读可评论权限，此属性为只读属性。|
|[Zoom](#zoom)|获取窗口缩放比例|
|[ZoomToFit](#zoomtofit)|对文档窗口大小进行调整后，是否缩放视图以适应文档窗口的尺寸|

### 方法列表

|方法|说明|
|-|-|
|[BuiltinDocumentProperties()](#builtindocumentproperties)|获取 Document 属性对象|
|[EndPlay()](#endplay)|退出播放模式|
|[ExportAsFixedFormat()](#exportasfixedformat)|导出文件为图片|
|[GetFileCreator()](#getfilecreator)|获取文件创建来源|
|[GetMenuPageIndex()](#getmenupageindex)|获取右键菜单所在页面|
|[GetOperatorsInfo()](#getoperatorsinfo)|获取登录操作者信息|
|[GetPageHeight()](#getpageheight)|通过页码获取指定页面高度|
|[GetPageRenderPicture()](#getpagerenderpicture)|指定页面转为图片|
|[GetPageWidth()](#getpagewidth)|通过页码获取指定页面宽度|
|[GetPointPageInfoByWinPoint()](#getpointpageinfobywinpoint)|通过相对窗口页面的坐标获取原始 PDF 页面的坐标和页码|
|[GetScreenModeInPlay()](#getscreenmodeinplay)|获取播放模式|
|[GetSelectionEndPos()](#getselectionendpos)|获取选区|
|[GetSelectionPicture()](#getselectionpicture)|获取选取图片|
|[GetTextSelection()](#gettextselection)|获取选区文本|
|[JumpToPage()](#jumptopage)|跳转到指定页|
|[PageTextData()](#pagetextdata)|获取指定页中的文本数据|
|[RotatePage()](#rotatepage)|PDF 旋转|
|[Save()](#save)|保存文件的改动|
|[ScrollTo()](#scrollto)|设置滚动位置|
|[SetCopyToastVisible()](#setcopytoastvisible)|控制复制提示|
|[SetOpenMarkerInkEdit()](#setopenmarkerinkedit)|开启画笔或者保存画笔并退出|
|[StartPlay()](#startplay)|设置播放模式|
|[SetSupportSelectArea()](#setsupportselectarea)|PDF 开启关闭框选功能|
|[PageCommentData()](#pagecommentdata)|PDF 获取指定页中的批注|
|[Find()](#find)|PDF 查找关键字|
|[FindNext()](#findnext)|PDF 查找下一个关键字，配合Find使用|
|[FindPrev()](#findprev)|PDF 查找上一个关键字，配合Find使用|
|[OpenAnnoList()](#openannolist)|PDF 打开批注列表|
<!-- DiscardFind我们和金山文档同不起效果，列表先去除，底部注释，注意顺序 -->

## CurrentPage

获取当前页码

### 语法

`表达式.ActivePDF.CurrentPage`

表达式：文档类型应用对象

### 返回值

返回 `Number` 表示对应的当前页码

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取当前页码
  const curryPage = await app.ActivePDF.CurrentPage
  console.log(curryPage)
}
```
## DocumentMap

控制目录的显示隐藏

### 语法

`表达式.ActivePDF.DocumentMap = Boolean`

表达式：文档类型应用对象

赋值 `Boolean` 为 `true` 显示目录，为 `false` 隐藏目录

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 控制目录的显示隐藏
  app.ActivePDF.DocumentMap = true
}
```
## DragMode

拖拽模式设置和获取

### 语法

`表达式.ActivePDF.DragMode`

表达式：文档类型应用对象

设置时

- true: 进入拖拽
- false: 退出拖拽

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const pdf = await app.ActivePDF

  // 设置拖拽模式
  pdf.DragMode = true

  // 获取拖拽模式
  const mode = await pdf.DragMode
  console.log(mode)
}
```
## PageMode

分页/连页模式切换

### 语法

`表达式.ActivePDF.PageMode = Number`

表达式：文档类型应用对象

设置 `Number` 值为 1 表示单页模式，设置为 0 表示多页模式。

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 单页/多页模式切换
  app.ActivePDF.PageMode = 1
}
```
## PagesCount

获取总页数

### 语法

`表达式.ActivePDF.PagesCount`

表达式：文档类型应用对象

### 返回值

返回 `Number` 表示对应的总页数

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取总页数
  const totalPages = await app.ActivePDF.PagesCount
  console.log(totalPages)
}
```
## PlayMode

播放状态设置和获取

### 语法

`表达式.ActivePDF.PlayMode`

表达式：文档类型应用对象

设置时

- true: 进入播放
- false: 进入播放
- start: 从第一页开始播放
- active: 从当前页开始播放

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const pdf = await app.ActivePDF

  // 设置播放状态
  pdf.PlayMode = 'start'

  // 获取播放状态
  const mode = await pdf.PlayMode
  console.log(mode)
}
```
## ReadOnly

返回一个值，表示文档是否只读，此属性为只读属性。

### 语法

`表达式.ActivePDF.ReadOnly`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const ReadOnly = await app.ActivePDF.ReadOnly
}
```
## ReadOnlyComment

返回一个值，表示文档是否只读可评论的权限，此属性为只读属性。

### 语法

`表达式.ActivePDF.ReadOnlyComment`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const ReadOnlyComment = await app.ActivePDF.ReadOnlyComment
}
```
## Scroll

获取滚动位置

### 语法

`表达式.ActivePDF.Scroll`

表达式：文档类型应用对象

### 返回值

返回滚动条位置`{x: xx, y: xx}`

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取滚动位置
  const result = await app.ActivePDF.Scroll
  console.log(result)
}
```
## ShowPages

获取可视区域内的所有页面索引

### 语法

`表达式.ActivePDF.ShowPages`

表达式：文档类型应用对象

### 返回值

返回 `Array` 类型的可视区域内的所有页面索引

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const pdf = await app.ActivePDF

  // 可视区域内的所有页面索引
  const pages = await pdf.ShowPages
  console.log(pages)
}
```
## ShowPagesTextData

获取可视区域内的所有页面的文本数据

### 语法

`表达式.ActivePDF.ShowPagesTextData`

表达式：文档类型应用对象

### 返回值

返回 `Array` 类型的可视区域内的所有页面的文本数据对象 object

#### object

| 属性    | 数据类型 | 说明     |
| ------- | -------- | -------- |
| pg      | Number   | 当前页数 |
| content | String   | 文本数据 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const pdf = await app.ActivePDF

  // 可视区域内的所有页面的文本数据
  const result = await pdf.ShowPagesTextData
  console.log(result)
}
```
## SupportReadOnlyComment

返回一个值，表示文档是否支持只读可评论权限，此属性为只读属性。

### 语法

`表达式.ActivePDF.SupportReadOnlyComment`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const SupportReadOnlyComment = await app.ActivePDF.SupportReadOnlyComment
}
```
## Zoom

获取窗口缩放比例

### 语法

`表达式.ActivePDF.Zoom`

表达式：文档类型应用对象

### 返回值

返回 `Number` 型的缩放比例

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取窗口缩放比例
  const result = await app.ActivePDF.Zoom
  console.log(result)

  // 设置窗口缩放比例
  app.ActivePDF.Zoom = 66
}
```
## ZoomToFit

对文档窗口大小进行调整后，是否缩放视图以适应文档窗口的尺寸

### 语法

`表达式.ActivePDF.ZoomToFit = Number`

表达式：文档类型应用对象

`Number` 依据不同值进行调整：

- `-1`：文档窗口大小进行调整后使页面以最佳尺寸适应活动窗口
- `0`：对文档窗口大小进行调整后不为适应文档窗口尺寸而缩放视图

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 窗口自适应
  app.ActivePDF.ZoomToFit = 0
}
```
## BuiltinDocumentProperties()

获取 Document 属性对象

### 语法

`表达式.ActivePDF.BuiltinDocumentProperties(Name)`

表达式：文档类型应用对象

### 参数

| 属性 | 数据类型 | 默认值 | 必填 | 说明     |
| ---- | -------- | ------ | ---- | -------- |
| Name | String   |        | 是   | 属性名称 |

### 返回值

| 属性     | 数据类型         | 说明              |
| -------- | ---------------- | ----------------- |
| documnet | DocumentProperty | Document 属性对象 |

#### DocumentProperty 结构

| 属性  | 数据类型 | 说明     |
| ----- | -------- | -------- |
| Name  | String   | 属性名称 |
| Value | String   | 属性值   |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //获取Document的Title属性对象
  const Title = await app.ActivePDF.BuiltinDocumentProperties('Title')
  console.log(Title)
}
```
## EndPlay()

退出播放模式

### 语法

`表达式.ActivePDF.EndPlay()`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.EndPlay()
}
```
## ExportAsFixedFormat()

导出文件为图片

### 语法

`表达式.ActivePDF.ExportAsFixedFormat({ FixedFormatType })`

表达式：文档类型应用对象

### 参数

| 属性            | 数据类型 | 默认值 | 必填 | 说明                                                                                                    |
| --------------- | -------- | ------ | ---- | ------------------------------------------------------------------------------------------------------- |
| FixedFormatType | Enum     | 0      | 可选 | 导出的类型，详细可参考 [Enum.FixedFormatType](/app-integration-dev/docs-center/online-preview-edit/client/Enum/PDF.html#fixedformattype)，目前仅支持导出图片 |
| Print           | Boolean  | false  | 可选 | 是否直接打开                                                                                            |
| ImgFormat       | Enum     | 0      | 可选 | 导出图片的格式，详细可参考 [Enum.ExportImgFormatType](/app-integration-dev/docs-center/online-preview-edit/client/Enum/PDF.html#exportimgformattype)         |
| Dpi             | Number   | 96     | 可选 | 图片质量                                                                                                |
| Combine2LongPic | Boolean  | false  | 可选 | 是否导出长图                                                                                            |
| RangeType       | Enum     | 0      | 可选 | 导出范围，详细可参考 [Enum.RangeType](/app-integration-dev/docs-center/online-preview-edit/client/Enum/PDF.html#rangetype)                                   |
| WaterMark       | Boolean  | false  | 可选 | 是否含水印                                                                                              |
| From            | Boolean  | 当前页 | 可选 | 起始页                                                                                                  |
| To              | Boolean  | 当前页 | 可选 | 结束页                                                                                                  |

### 返回值

返回打印的 `url`。

| 属性 | 数据类型 | 说明       |
| ---- | -------- | ---------- |
| url  | string   | 打印的 url |

### 示例：导出图片

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 导出文件为图片
  const imgUrl = await app.ActivePDF.ExportAsFixedFormat({
    FixedFormatType: app.Enum.FixedFormatType.TypeIMG
  })
  console.log(imgUrl)
}
```
## GetFileCreator()

获取文件创建来源

### 语法

`表达式.ActivePDF.GetFileCreator()`

表达式：文档类型应用对象

### 返回值

| 属性   | 数据类型 | 说明         |
| ------ | -------- | ------------ |
| result | String   | 文件创建来源 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //文件创建来源
  const creator = await app.ActivePDF.GetFileCreator()
  console.log(creator)
}
```
## GetMenuPageIndex()

获取右键菜单所在页面

### 语法

`表达式.ActivePDF.GetMenuPageIndex()`

表达式：文档类型应用对象

### 返回值

| 属性   | 数据类型 | 说明              |
| ------ | -------- | ----------------- |
| result | Number   | 页数（从 1 开始） |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.GetMenuPageIndex()
}
```
## GetOperatorsInfo()

获取登录操作者信息

### 语法

`表达式.ActivePDF.GetOperatorsInfo()`

表达式：文档类型应用对象

### 返回值

**Object object**

| 属性     | 数据类型 | 说明         |
| -------- | -------- | ------------ |
| type     | String   | 请求类型     |
| response | Object   | 用户信息列表 |

#### response 结构

| 属性       | 数据类型 | 说明         |
| ---------- | -------- | ------------ |
| id         | String   | 用户 id      |
| avatar_url | Object   | 用户头像     |
| logined    | Object   | 用户登录状态 |
| name       | Object   | 用户姓名     |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取登录操作者信息
  const operatorsInfo = await app.ActivePDF.GetOperatorsInfo()
  console.log(operatorsInfo)
}
```
## GetPageHeight()

通过页码获取指定页面高度

### 语法

`表达式.ActivePDF.GetPageHeight(PageIndex)`

表达式：文档类型应用对象

### 参数

| 属性      | 数据类型 | 默认值 | 必填 | 说明                |
| --------- | -------- | ------ | ---- | ------------------- |
| PageIndex | Number   | 无     | 是   | 页码(索引从 1 开始) |

### 返回值

返回`Number`表示指定页码页面的高度。

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取指定页码页面的高度,索引从1开始
  const pageHeight = await app.ActivePDF.GetPageHeight(1)
  console.log(pageHeight)
}
```
## GetPageRenderPicture()

指定页面转为图片

### 语法

`表达式.ActivePDF.GetPageRenderPicture({Index})`

表达式：文档类型应用对象

### 参数

| 属性   | 数据类型 | 说明     |
| --- | ---- | ---- |
| Index | Number   | 指定的页数，从1开始 |

### 返回值

| 属性   | 数据类型 | 说明     |
| ------ | -------- | -------- |
| result | String   | 图片地址 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const result = await app.ActivePDF.GetPageRenderPicture(1)
}
```
## GetPageWidth()

通过页码获取指定页面宽度

### 语法

`表达式.ActivePDF.GetPageWidth(PageIndex)`

表达式：文档类型应用对象

### 参数

| 属性      | 数据类型 | 默认值 | 必填 | 说明                |
| --------- | -------- | ------ | ---- | ------------------- |
| PageIndex | Number   | 无     | 是   | 页码(索引从 1 开始) |

### 返回值

返回`Number`表示指定页码页面的宽度。

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取指定页码页面的宽度,索引从1开始
  const pageWidth = await app.ActivePDF.GetPageWidth(1)
  console.log(pageWidth)
}
```
## GetPointPageInfoByWinPoint()

通过相对窗口页面的坐标获取原始 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 坐标                                             |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 通过相对窗口的坐标,获取到对应的点在原始页面的坐标和页码
  const pointPageInfo = await app.ActivePDF.GetPointPageInfoByWinPoint(500, 500)
  console.log(pointPageInfo)
}
```
## GetScreenModeInPlay()

获取播放模式

### 语法

`表达式.ActivePDF.GetScreenModeInPlay()`

表达式：文档类型应用对象

### 返回值

| 属性 | 数据类型 | 说明                                            |
| ---- | -------- | ----------------------------------------------- |
| mode | String   | 播放模式,可能值 vertical、horizontal、undefined |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //播放模式
  const mode = await app.ActivePDF.GetScreenModeInPlay()
  console.log(mode)
}
```
## GetSelectionEndPos()

获取选区

### 语法

`表达式.ActivePDF.GetSelectionEndPos()`

表达式：文档类型应用对象

### 返回值

| 属性         | 数据类型 | 说明          |
| ------------ | -------- | ------------- |
| hasSelection | Boolean  | 是否选中      |
| x            | Number   | 选区 x 轴坐标 |
| y            | Number   | 选区 y 轴坐标 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //获取选区
  const selectionEndPos = await app.ActivePDF.GetSelectionEndPos()
  console.log(selectionEndPos)
}
```
## GetSelectionPicture()

获取选取图片

### 语法

`表达式.ActivePDF.GetSelectionPicture()`

表达式：文档类型应用对象

### 返回值

| 属性   | 数据类型 | 说明     |
| ------ | -------- | -------- |
| result | String   | 图片地址 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.GetSelectionPicture()
}
```
## GetTextSelection()

获取选区文本

### 语法

`表达式.ActivePDF.GetTextSelection()`

表达式：文档类型应用对象

### 返回值

| 属性 | 数据类型 | 说明         |
| ---- | -------- | ------------ |
| Text | String   | 选区文本内容 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //获取选区文本
  const selectionText = await app.ActivePDF.GetTextSelection()
  console.log(selectionText)
}
```
## JumpToPage()

跳转到指定页

### 语法

`表达式.ActivePDF.JumpToPage(PageNum)`

表达式：文档类型应用对象

### 参数

| 属性    | 数据类型 | 默认值 | 必填 | 说明         |
| ------- | -------- | ------ | ---- | ------------ |
| PageNum | Number   |        | 是   | 跳转到的页码 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 跳转到指定页
  await app.ActivePDF.JumpToPage(3)
}
```
## PageTextData()

获取指定页中的文本数据

### 语法

`表达式.ActivePDF.PageTextData(PageIndex)`

表达式：文档类型应用对象

### 参数

| 属性      | 数据类型 | 默认值 | 必填 | 说明                  |
| --------- | -------- | ------ | ---- | --------------------- |
| PageIndex | Number   |        | 是   | 指定的页数，从 1 开始 |

### 返回值

| 属性   | 数据类型 | 说明                            |
| ------ | -------- | ------------------------------- |
| result | Array    | 数组包裹返回文本数据对象 Object |

#### result 结构中文本数据对象 Object

| 属性    | 数据类型 | 说明     |
| ------- | -------- | -------- |
| pg      | Number   | 当前页数 |
| content | String   | 文本数据 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //第一页的文本数据
  const result = await app.ActivePDF.PageTextData(1)
  console.log(result)
}
```
## RotatePage()

PDF 旋转

### 语法

`表达式.ActivePDF.RotatePage(Value)`

表达式：文档类型应用对象

### 参数

| 属性  | 数据类型 | 默认值 | 必填 | 说明     |
| ----- | -------- | ------ | ---- | -------- |
| Value | Number   | -      | 否   | 旋转角度 |

1. 参数可以为空，调用一次就在当前的角度上加 90 度
2. 设置为 0(设置文档旋转角度为 0 度)
3. 设置为 90(设置文档旋转角度为 90 度)
4. 设置为 180(设置文档旋转角度为 180 度)
5. 设置为 270(设置文档旋转角度为 270 度)

其他值都为非法参数

### 返回值

Boolean

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const success = await app.ActivePDF.RotatePage()
  console.log('success: ', success)
}
```
## Save()

保存文件的改动

### 语法

`表达式.ActivePDF.Save()`

表达式：文档类型应用对象

### 返回值

| 属性    | 数据类型 | 说明                |
| ------- | -------- | ------------------- |
| result  | String   | 保存状态            |
| size    | Number   | 文件大小，单位 byte |
| version | Number   | 版本                |

**保存状态说明**：

| 保存状态       | 说明                                                          |
| -------------- | ------------------------------------------------------------- |
| ok             | 版本保存成功，可在历史版本中查看                              |
| nochange       | 文档无更新，无需保存版本                                      |
| SavedEmptyFile | 暂不支持保存空文件 触发场景：内核保存完后文件为空             |
| SpaceFull      | 空间已满                                                      |
| QueneFull      | 保存中请勿频繁操作 触发场景：服务端处理保存队列已满，正在排队 |
| fail           | 保存失败                                                      |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 保存文件的改动
  const saveResult = await app.ActivePDF.Save()
  console.log(saveResult)
}
```
## ScrollTo()

设置滚动位置

### 语法

`表达式.ActivePDF.ScrollTo(x, y)`

表达式：文档类型应用对象

### 参数

| 属性 | 数据类型 | 默认值 | 必填 | 说明              |
| ---- | -------- | ------ | ---- | ----------------- |
| x    | Number   |        | 否   | 滚动位置的 x 坐标 |
| y    | Number   |        | 否   | 滚动位置的 y 坐标 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.ScrollTo(100, 100)
}
```
## SetCopyToastVisible()

控制复制提示

### 语法

`表达式.ActivePDF.SetCopyToastVisible(Visible)`

表达式：文档类型应用对象

### 参数

| 属性    | 数据类型 | 默认值 | 必填 | 说明             |
| ------- | -------- | ------ | ---- | ---------------- |
| Visible | Boolean  | false  | 否   | 是否显示复制提示 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  //显示复制提示
  await app.ActivePDF.SetCopyToastVisible(true)
}
```
## SetOpenMarkerInkEdit()

开启画笔或者保存画笔并退出

### 语法

`表达式.ActivePDF.SetOpenMarkerInkEdit({ Open })`

表达式：文档类型应用对象

### 参数

| 属性 | 数据类型 | 默认值 | 必填 | 说明                                                  |
| ---- | -------- | ------ | ---- | ----------------------------------------------------- |
| Open | Boolean  | true   | 否   | 是否需要开启画笔（true），还是保存并关闭画笔（false） |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 开启画笔
  await app.ActivePDF.SetOpenMarkerInkEdit(true)

  setTimeout(async () => {
    // 保存画笔并关闭
    await app.ActivePDF.SetOpenMarkerInkEdit(false)
  }, 5000)
}
```
## StartPlay()

设置播放模式

### 语法

`表达式.ActivePDF.StartPlay(type, DisFullscreen, HiddenMenu)`

表达式：文档类型应用对象

### 参数

| 属性          | 数据类型 | 默认值 | 必填 | 说明         |
| ------------- | -------- | ------ | ---- | ------------ |
| type          | String   | active | 否   | 播放模式     |
| DisFullscreen | Boolean  | false  | 否   | 是否全屏     |
| HiddenMenu    | Boolean  | false  | 否   | 是否隐藏菜单 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.StartPlay('active', true, true)
}
```
## SetSupportSelectArea()

> JSSDK:v1.1.19+ 支持

PDF 开启关闭框选功能

### 语法

`表达式.ActivePDF.SetSupportSelectArea({isSupport})`

表达式：文档类型应用对象

### 参数

| 属性  | 数据类型 | 默认值 | 必填 | 说明 |
| ----- | -------- | ------ | ---- | ----- |
| isSupport | Boolean | true | 否 | 开启关闭框选功能 |

1. 设置true，开启框选功能
2. 设置false，关闭框选功能

其他值都为非法参数


### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 开启框选功能
  await app.ActivePDF.SetSupportSelectArea({ isSupport: true });
}
```
## PageCommentData()

> JSSDK:v1.1.19+ 支持

PDF 获取指定页中的批注

### 语法

`表达式.ActivePDF.PageCommentData({PageIndex})`

表达式：文档类型应用对象

### 参数

| 属性  | 数据类型 | 默认值 | 必填 | 说明 |
| ----- | -------- | ------ | ---- | ----- |
| PageIndex | Number | - | 是 | 指定的页数，从1开始 |

### 返回值

| 属性 | 数据类型 | 说明 |
| --- | --- | --- |
| - | Array | 对象数组 |

#### 数据对象Object

| 属性 | 数据类型 | 说明 |
| --- | --- | --- |
| id | String | 批注id |
| items | Array | 注解批注评论数据 |

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  const data = await app.ActivePDF.PageCommentData({ PageIndex: 1 });
  console.log('data: ', data);
}
```
## Find()

> JSSDK:v1.1.19+ 支持

PDF 查找关键字

### 语法

`表达式.ActivePDF.Find({Value})`

表达式：文档类型应用对象

### 参数

| 属性  | 数据类型 | 默认值 | 必填 | 说明 |
| ----- | -------- | ------ | ---- | ----- |
| Value | String/Array | - | 否 | 查找的参数 |

1. 多个关键字查找传入字符串数组， ['hello', '你好']

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  await app.ActivePDF.Find({ Value: 'hello' });
}
```
## FindNext()

> JSSDK:v1.1.19+ 支持

PDF 查找下一个关键字，配合Find使用

### 语法

`表达式.ActivePDF.FindNext()`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  await app.ActivePDF.FindNext();
}
```
## FindPrev()

> JSSDK:v1.1.19+ 支持

PDF 查找上一个关键字，配合Find使用

### 语法

`表达式.ActivePDF.FindPrev()`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  await app.ActivePDF.FindPrev();
}
```
<!-- ## DiscardFind()

> JSSDK:v1.1.19+ 支持

PDF 取消查找

### 语法

`表达式.ActivePDF.DiscardFind()`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  await app.ActivePDF.DiscardFind();
}
``` -->
## OpenAnnoList()

> JSSDK: v1.1.19+ 支持

PDF 打开批注列表

### 语法

`表达式.ActivePDF.OpenAnnoList()`

表达式：文档类型应用对象

### 示例

```js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  await app.ActivePDF.OpenAnnoList();
}
```