Class Range

范围

文档中的元素范围。用户的选择会以 Range 的形式表示，以及其他用途。脚本只能访问运行脚本的用户的选择，并且只有在脚本绑定到文档的情况下才能访问。

// Bold all selected text.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  for (let i = 0; i < elements.length; i++) {
    const element = elements[i];

    // Only modify elements that can be edited as text; skip images and other
    // non-text elements.
    if (element.getElement().editAsText) {
      const text = element.getElement().editAsText();

      // Bold the selected part of the element, or the full element if it's
      // completely selected.
      if (element.isPartial()) {
        text.setBold(
            element.getStartOffset(),
            element.getEndOffsetInclusive(),
            true,
        );
      } else {
        text.setBold(true);
      }
    }
  }
}

方法

方法	返回类型	简介
getRangeElements()	RangeElement[]	获取此 Range 中的所有元素，包括任何部分 Text 元素（例如，如果选择仅包含 Text 元素的一部分）。

已弃用的方法

方法	返回类型	简介
getSelectedElements()	RangeElement[]	获取用户在文档的打开实例中选择的所有元素，包括任何部分选中的 Text 元素。

详细文档

getRangeElements()

获取此 Range 中的所有元素，包括任何部分 Text 元素（例如，如果选择仅包含 Text 元素的一部分）。如需确定 Text 元素是否仅部分包含在范围内，请参阅 RangeElement.isPartial()。

返回

RangeElement[] - 元素数组，按文档中显示的顺序

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

已弃用的方法

getSelectedElements()

已弃用。已重命名为 getRangeElements()。

获取用户在文档的打开实例中选择的所有元素，包括任何部分选中的 Text 元素。

返回

RangeElement[] - 一个包含已选择或部分选择的元素的数组，按元素在文档中显示的顺序排列

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents