Class NamedRange

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

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

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

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

Методы

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

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

get Id()

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

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

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

get Name()

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

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

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

Авторизация

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

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

get Range()

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

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

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

Авторизация

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

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

remove()

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

Авторизация

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

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