区域（range）

区域说明

文档区域对象，用于表示文档中的一个连续区域

每个选区值包含了起始位置和结束位置信息的字符串。

属性列表

属性	说明
start	获取区域开始的位置
end	获取区域结束的位置

方法列表

方法	说明
getText()	获取指定区域的纯文本
getHtml()	获取指定区域的 HTML 片段
setText()	设置指定区域的内容为指定纯文本
setHtml()	设置指定区域的内容为指定 HTML 片段
getBounding()	获取选区在当前屏幕上的位置信息，或传入选区的位置信息

start

获取区域开始的位置。

语法

range.start

使用示例

function async example() {

  const document = await sdk.connect();

  //获取选区
  const range = await document.selection.getRange();

  //获取选区开始的位置
  const rangeStart = await range.start

}

end

获取区域结束的位置。

语法

range.end

使用示例

function async example() {

  const document = await sdk.connect();

  //获取选区
  const range = await document.selection.getRange();

  //获取选区结束的位置
  const rangeStart = await range.end

}

getText()

获取指定区域的纯文本。

语法

range.getText()

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取选区
  const range = await document.selection.getRange();
  
  //获取选区的纯文本
  const text = await range.getText()

}

getHtml()

获取指定区域的 HTML 片段。

语法

range.getHtml()

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取选区
  const range = await document.selection.getRange();
  
  //获取选区的 HTML 片段
  const html = await range.getHtml()

}

setText()

设置指定区域的内容为指定纯文本。

语法

range.setText()

参数

参数	类型	必填	说明
text	string	否	指定要设置的纯文本内容，用于替换范围内的现有内容。如果未提供，默认清空范围内容。

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取选区
  const range = await document.selection.getRange();
  
  //设置选区内容为指定纯文本
  await range.setText('For example')

}

setHtml()

设置指定区域的内容为指定 HTML 片段。

语法

range.setHtml()

参数

参数	类型	必填	说明
html	string	否	指定要设置的 html 片段，用于替换范围内的现有内容。如果未提供，默认清空范围内容。

使用示例

function async example() {

  const document = await sdk.connect();
  
  //获取选区
  const range = await document.selection.getRange();
  
  //设置选区内容为指定 html 片段
  await range.setHtml('<div style="border: 2px; font-size: 16px">For example</div>')

}

getBounding()

获取选区在当前屏幕上的位置信息，或传入选区的位置信息。

语法

range.getBounding()

使用示例

function async example() {

  const document = await sdk.connect();

  //获取选区
  const range = await document.selection.getRange();

  //获取位置信息
  const bounding = await range.getBounding();
  
  // 区域最后一个字符的坐标
  const endPosition = {
    x: bounding.end,
    y: bounding.bottom
  }

}

区域说明#

属性列表#

方法列表#

start#

end#

getText()#

getHtml()#

setText()#

setHtml()#

getBounding()#

区域说明

属性列表

方法列表

start

end

getText()

getHtml()

setText()

setHtml()

getBounding()