Class Range  |  Apps Script  |  Google for Developers (original) (raw)

Class Range

Stay organized with collections Save and categorize content based on your preferences.

Range

A range of elements in a document. The user's selection is represented as a Range, among other uses. Scripts can only access the selection of the user who is running the script, and only if the script is bound to the document.

// 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);
  }
}

} }

Methods

Deprecated methods

Detailed documentation

getRangeElements()

Gets all elements in this Range, including any partial [Text](/apps-script/reference/document/text) elements (for example, in the case of a selection that includes only part of a Text element). To determine whether aText element is only partially included in the range, see [RangeElement.isPartial()](/apps-script/reference/document/range-element#isPartial%28%29).

Return

[RangeElement[]](/apps-script/reference/document/range-element) — an array of elements, in the order they appear in the document

Scripts that use this method require authorization with one or more of the following scopes:

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

Deprecated methods

getSelectedElements()

Deprecated. Renamed to [getRangeElements()](#getRangeElements%28%29).

Gets all elements that the user has selected in the open instance of the document, including any partially selected [Text](/apps-script/reference/document/text)elements.

Return

[RangeElement[]](/apps-script/reference/document/range-element) — an array of selected or partially selected elements, in the order they appear in the document

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-02 UTC.