Class NamedRange

NamedRange

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

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

// 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 с вкладки.

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

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