选区（selection）

选区说明

表示窗口中的当前选定内容。

选定内容表示文档中的选定（或突出显示）区域，或者代表插入点（如果未选择文档中的任何内容）。

方法列表

方法	说明
getRange()	获取一个选区或指定区域
setRange()	选中指定的区域
addRangeListener()	添加选区变化监听器
getWholeRange()	添加选区变化监听器

getRange()

获取一个选区或指定区域。

语法

document.selection.getRange(range?)

参数

参数	类型	必填	说明
range	object	否	可选参数，包含 start 和 end 的对象，用于指定选区的起始和结束位置。如果传入 range，则 range 中必需此字段
range.start	string	否	区域开始位置的编码字符串，表示选中内容的起始位置。若不传入，默认获取当前选区的起始位置。
range.end	string	否	区域结束位置的编码字符串，表示选中内容的结束位置。若不传入，默认获取当前选区的结束位置。

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取选区
  const range = await document.selection.getRange();
  
  //获取指定区域
  const newRange = await document.selection.getRange({ start: 'NHwwfDQ=', end: 'NHwwfDA=' })

}

setRange()

选中指定的区域。

语法

document.selection.setRange(range)

参数

参数	类型	必填	说明
range	object	是	一个表示选区范围的对象，通常由 getRange 或其他方法返回。包含 start 和 end 的对象，用于指定选区的起始和结束位置。
range.start	string	是	区域开始位置的编码字符串，表示选中内容的起始位置。range 中必需此字段。
range.end	string	是	区域结束位置的编码字符串，表示选中内容的结束位置。range 中必需此字段。

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取区域
  const range = await document.selection.getRange({ start: 'NHwwfDQ=', end: 'NHwwfDA=' });
  
  //选中区域
  await document.selection.setRange(range)

}

addRangeListener()

添加选区变化监听器，当选区发生变化时，会触发回调。

语法

document.selection.addRangeListener(listener: (value: DocxRangeValue | null) => void
)

使用示例

function async example() {
  const document = await sdk.connect();
  const listener = (range) => { console.log(range); }
  // 选区变化时触发回调 listener
  document.selection.addRangeListener(listener);
}

getWholeRange()

获取全部区域。

该接口于 V1.1.3 版本启用。

语法

document.selection.getWholeRange(range?)

使用示例

function async example() {

  const document = await sdk.connect();

  //获取全部区域
  const range = await document.selection.getWholeRange();
}

选区说明#

方法列表#

getRange()#

setRange()#

addRangeListener()#

getWholeRange()#

选区说明

方法列表

getRange()

setRange()

addRangeListener()

getWholeRange()