WebOffice 开放平台

主题

回到顶部
本页内容

编辑器(Editor)

方法列表

方法说明
Undo()
撤销操作
Redo()
恢复操作
GetUndoStatus()
获取撤销状态
GetRedoStatus()
获取恢复状态
GetEditMode()
【移动端】获取 阅读模式和编辑模式 状态
ToggleEditMode({EditMode})
【移动端】进入/退出 编辑模式

Undo()

撤销操作

语法

表达式.ActiveOutline.Editor.Undo()

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

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const paragraphs = await editor.Document.Paragraphs;
  
  // 设置标题格式等级 2
  await paragraphs.SetHeader(2);

  // 撤销上次操作
  await editor.Undo();
}

Redo()

恢复操作

语法

表达式.ActiveOutline.Editor.Redo()

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

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const paragraphs = await editor.Document.Paragraphs;
  
  // 设置标题格式等级 2
  await paragraphs.SetHeader(2);
  // 撤销上次操作
  await editor.Undo();

  // 恢复
  await editor.Redo();
}

GetUndoStatus()

获取撤销状态

语法

表达式.ActiveOutline.Editor.GetUndoStatus()

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

返回值

返回 Boolean 值，true 表示可以撤销，false 表示不能撤销

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  
  const GetUndoStatus = await editor.GetUndoStatus();
  console.log('GetUndoStatus: ', GetUndoStatus);
}

GetRedoStatus()

获取恢复状态

语法

表达式.ActiveOutline.Editor.GetRedoStatus()

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

返回值

返回 Boolean 值，true 表示可以恢复，false 表示不能恢复

示例

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

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  
  const GetRedoStatus = await editor.GetRedoStatus();
  console.log('GetRedoStatus: ', GetRedoStatus);
}

GetEditMode()

【移动端】获取 阅读模式和编辑模式 状态

语法

表达式.ActiveOutline.Editor.GetEditMode()

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

返回值

返回 true 表示在编辑模式，false 表示在阅读模式

示例

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

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

  const GetEditMode = await editor.GetEditMode();
  console.log('GetEditMode: ', GetEditMode);
}

ToggleEditMode({ EditMode })

【移动端】进入/退出 编辑模式

语法

表达式.ActiveOutline.Editor.ToggleEditMode({ EditMode })

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

参数

属性数据类型默认值必填说明
EditMode
String
是
EDIT: 编辑模式，READ: 阅读模式

示例

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

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

  // 进入编辑模式
  await editor.ToggleEditMode('EDIT');

  // 进入阅读模式
  // await editor.ToggleEditMode('READ');
}