Class NamedRange

Именованныйдиапазон

Range , имеющий имя и идентификатор, позволяющий его позднее получить. Имена не обязательно уникальны; несколько разных диапазонов на одной вкладке могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри вкладки, как идентификатор в HTML. После добавления NamedRange на вкладку его нельзя изменить, а только удалить.

Доступ NamedRange может получить любой скрипт, обращающийся к вкладке. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

Методы

Метод Тип возврата Краткое описание
getId() String Получает идентификатор этого NamedRange .
getName() String Получает имя этого NamedRange .
getRange() Range Получает диапазон элементов, связанных с этим NamedRange .
remove() void Удаляет этот NamedRange с вкладки.

Подробная документация

getId()

Получает идентификатор этого NamedRange . Идентификатор уникален в пределах вкладки.

Возвращаться

String — идентификатор диапазона, уникальный в пределах вкладки.

getName()

Получает имя этого NamedRange . Имя не обязательно уникально.

Возвращаться

String — имя диапазона, которое не обязательно уникально.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getRange()

Получает диапазон элементов, связанных с этим NamedRange .

Возвращаться

Range — диапазон элементов, связанных с именем и идентификатором.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

remove()

Удаляет этот NamedRange с вкладки. Этот метод не удаляет содержимое диапазона; это просто удаляет ссылку. Вызов этого метода для NamedRange , который уже был удален, не имеет никакого эффекта.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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