WebOffice 开放平台

主题

回到顶部
本页内容

选区/光标(Selection)

方法列表

方法说明
SetSelection({From,To})
设置选区
SetOpenCollaborationSelection({Enabled})
是否展示其他「协作的光标」和选区，是否同步『光标和选区』给其他协作者
SetEditorFocus({Focus})
设置聚焦状态（加强版）
SetFocus({Focus})
设置聚焦状态（简单版）
IsOrderedList()
光标所在位置是否为有序列表
IsBulletList()
光标所在位置是否为无序列表
IsTaskList()
光标所在位置是否为任务列表

SetSelection( {From,To} )

设置选区

语法

表达式.ActiveOutline.Editor.Document.Selection.SetSelection({ From, To })

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

参数

属性数据类型默认值必填说明
From
Number
否
开始位置
To
Number
否
结束位置

示例

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

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

  // 设置选区
  await selection.SetSelection(1, 10);
}

SetOpenCollaborationSelection({ Enabled })

是否展示其他「协作的光标」和选区，是否同步『光标和选区』给其他协作者

语法

表达式.ActiveOutline.Editor.Document.Selection.SetOpenCollaborationSelection({ Enabled })

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

参数

属性数据类型默认值必填说明
Enabled
Boolean
否
设为 false 时不展示其他人的选区，但同步光标给其他协作者；设置为 true 时提供光标和选区给其他协作者

示例

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

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

  // 不展示其他人的选区，但同步光标给其他协作者
  await selection.SetOpenCollaborationSelection(false);
}

SetEditorFocus({ Focus })

设置聚焦状态（加强版）

语法

表达式.ActiveOutline.Editor.Document.Selection.SetEditorFocus({ Focus })

目前仅 PC 端支持

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

参数

属性数据类型默认值必填说明
Focus
Boolean
true
否
设置 true 为聚焦，设置 false 为失焦。这里的失焦指不显示区选效果、不显示光标、不显示菜单等

示例

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

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

  // 设置编辑器失焦
  await selection.SetEditorFocus({
    Focus: false,
  });
}

SetFocus({ Focus })

设置聚焦状态（简单版）

语法

表达式.ActiveOutline.Editor.Document.Selection.SetFocus({ Focus })

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

参数

属性数据类型默认值必填说明
Focus
Boolean
true
否
设置 true 为聚焦，设置 false 为失焦。这里的失焦指光标失焦

示例

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

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

  // 设置编辑器聚焦
  await selection.SetFocus({
    Focus: true,
  });
}

IsOrderedList()

光标所在位置是否为有序列表

语法

表达式.ActiveOutline.Editor.Document.Selection.IsOrderedList()

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

返回值

true 表示是有序；false 表示非有序

示例

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

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

  const IsOrderedList = await selection.IsOrderedList();
  console.log('IsOrderedList: ', IsOrderedList);
}

IsBulletList()

光标所在位置是否为无序列表

语法

表达式.ActiveOutline.Editor.Document.Selection.IsBulletList()

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

返回值

返回 true 表示在无序列表

示例

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

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

  const IsBulletList = await selection.IsBulletList();
  console.log('IsBulletList: ', IsBulletList);
}

IsTaskList()

光标所在位置是否为任务列表

语法

表达式.ActiveOutline.Editor.Document.Selection.IsTaskList()

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

返回值

true 表示是任务列表； false 表示非任务列表

示例

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

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

  const IsTaskList = await selection.IsTaskList();
  console.log('IsTaskList: ', IsTaskList);
}