文档(Doc)

方法列表

方法	说明
GetContent()	获取文档内容（简单文本数据）
GetContentAll({Params})	获取文档内容（JSON 详细数据）
GetDocText()	获取文档的文本数据
GetTitleContent()	获取标题
SetTitleContent({Content})	设置标题
InsertPictureInterface()	【移动端】唤起插入图片的面板

GetContent()

获取文档内容（简单文本数据）

语法

表达式.ActiveOutline.Editor.Document.GetContent()

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

返回值

属性	数据类型	说明
content	String	文档内容

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  
  // 获取文档内容
  const GetContent = await doc.GetContent();
  console.log('GetContent: ', GetContent);
}

GetContentAll({ Params })

获取文档内容（JSON 详细数据）

语法

表达式.ActiveOutline.Editor.Document.GetContentAll({ Params })

提示：ActiveOutline.GetContent() 用于获取文档内容的简单文本数据，ActiveOutline.GetContentAll() 获取的是文档内容的 JSON 详细数据。

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

参数

属性	数据类型	必填	说明
args	ObjectArray	是	查询内容列表（详细参数见表1）

表1：

参数	数据类型	必填	说明
name	String	是	查询内容的名称（可查询内容见表3）
data	Object	否	查询条件（详见表2）

表2：

参数	数据类型	必填	说明
num	Int	否	指定查询数量（对"title" 无效）

表3：可查询的内容

内容名称	描述
title	文档标题
mainBody	文档正文
picture	图片节点
processon	在线作图工具节点
staticTime	时间节点
WPSUser	联系人节点
WPSDocument	云文档节点
schedule	日程节点

返回值

参数	数据类型	说明
data	Object	数据内容 以入参args参数中的name为key值，组织节点数组返回数据
version	String	json结构版本

JSON数据格式说明文档：

参考文档：AP-JSON数据格式说明文档

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;

  const params = {
    args: [
      { name: 'title' },
      { name: 'mainBody' },
      { name: 'picture' },
      { name: 'staticTime' },
      { name: 'WPSUser' },
      { name: 'WPSDocument' },
    ],
  }

  const GetContentAll = await doc.GetContentAll(params)
  console.log('GetContentAll: ', GetContentAll);
}

GetDocText()

获取文档的文本数据

语法

表达式.ActiveOutline.Editor.Document.GetDocText()

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

返回值

属性	数据类型	说明
content	String	Array
type	String	文本类型

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;

  // 获取文档内容的文本数据
  const GetDocText = await doc.GetDocText(params)
  console.log('GetDocText: ', GetDocText);
}

GetTitleContent()

获取标题

语法

表达式.ActiveOutline.Editor.Document.GetTitleContent()

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

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  
  // 获取文档中标题
  const GetTitleContent = await doc.GetTitleContent();
  console.log('GetTitleContent: ', GetTitleContent);
}

SetTitleContent({ Content })

设置标题

语法

表达式.ActiveOutline.Editor.Document.SetTitleContent({ Content })

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

参数

属性	数据类型	默认值	必填	说明
Content	String		是	标题内容

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  
  // 修改文档的标题
  await doc.SetTitleContent('Hello 金山文档开放平台');
}

InsertPictureInterface()

【移动端】唤起插入图片的面板

语法

表达式.ActiveOutline.Editor.Document.Pictures.InsertPictureInterface()

使用前提：用户光标在编辑区域

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

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const pictures = await doc.Pictures;

  // 【移动端】唤起插入图片的面板
  await pictures.InsertPictureInterface();
}