文档对象(Document)

此对象代表文档实例，其为文档操作的顶级对象，开发者可以轻松的通过它获取到文当对象，进而对其进行相关接口的调用。

属性列表

属性	类型	说明
Bookmarks	Bookmarks	Bookmarks 集合，该集合代表指定文档的所有书签
Comments	Comments	Comments 集合，该集合代表指定文档的所有批注
FileInfo	FileInfo	当前文档的信息
Revisions	Revisions	Revisions 集合，该集合代表指定文档的所有修订
WaterMarks	WaterMarks	WaterMarks 集合，该集合代表指定文档的所有水印
TemporaryWatermark	TemporaryWatermark	TemporaryWatermark 对象，该对象代表当前文档的临时水印

方法列表

方法	返回类型	说明
Download()	无	下载当前文档
Export()	无	导出当前文档
Print()	无	打印当前文档
Save()	无	主动保存当前文档
SetReadOnly()	无	设置或取消当前文档的只读状态

Bookmarks

返回一个 Bookmarks 集合，该集合代表指定文档的所有书签。此为只读属性

语法

表达式.ActiveDocument.Bookmarks

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 Bookmarks 对象
  const Comments = await app.ActiveDocument.Bookmarks;
}

Comments

返回一个 Comments 集合，该集合代表指定文档的所有批注。此为只读属性

语法

表达式.ActiveDocument.Comments

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 Comments 对象
  const Comments = await app.ActiveDocument.Comments;
}

Revisions

返回一个 Revisions 集合，该集合代表指定文档的所有修订。此为只读属性

语法

表达式.ActiveDocument.Revisions

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 Revisions 对象
  const Revisions = await app.ActiveDocument.Revisions;
}

WaterMarks

返回一个 WaterMarks 集合，该集合代表指定文档的所有水印。此为只读属性

语法

表达式.ActiveDocument.WaterMarks

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 WaterMarks 对象
  const WaterMarks = await app.ActiveDocument.WaterMarks;
}

TemporaryWatermark

返回一个 TemporaryWatermark 对象，该对象代表指定文档的临时水印。此为只读属性

语法

表达式.ActiveDocument.TemporaryWatermark

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 TemporaryWatermark 对象
  const TemporaryWatermark = await app.ActiveDocument.TemporaryWatermark;
}

IMPORTANT

临时水印（TemporaryWatermark）与水印（WaterMarks）存在区别：

• TemporaryWatermark 是临时覆盖在文档上的水印，主要是为了对截图等场景做留痕，不会存入文档内部，下载、打印时不存在。
• WaterMarks 的设置会存储到文档内部，下载、打印时依然存在。

FileInfo

文档基础信息对象

语法

表达式.ActiveDocument.FileInfo

返回值

字段	类型	说明
FileId	String	文件 id，用于 WebOffice 系统内部交互
OutFileId	String	接入方的原始文件 id
Title	String	文档标题
OfficeType	String	编辑器类型，文字：w，表格：s，演示：p
FileType	String	文档扩展名 ，如 docx、xlsx

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 返回一个 FileInfo 对象
  const FileInfo = await app.ActiveDocument.FileInfo;
}

Download()

下载当前文档

语法

表达式.ActiveDocument.Download()

示例

jssdk.Application.ActiveDocument.Download();

Export()

导出当前文档，目前只支持 pdf 类型

语法

表达式.ActiveDocument.Export({ exportFormat: "pdf" })

示例

jssdk.Application.ActiveDocument.Export({ exportFormat: "pdf" });

Print()

打印当前文档

语法

表达式.ActiveDocument.Print()

示例

jssdk.Application.ActiveDocument.Print();

Save()

主动保存当前文档

语法

表达式.ActiveDocument.Save()

示例

jssdk.Application.ActiveDocument.Save();

SetReadOnly()

设置或取消当前文档的只读状态

语法

表达式.ActiveDocument.SetReadOnly({ readOnly })

参数

属性	类型	说明
readOnly	Boolean	是否只读

示例

jssdk.Application.ActiveDocument.SetReadOnly({ readOnly: true });