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