Эта страница переведена с помощью Cloud Translation API.

Class DocumentTab

Вкладка документа, содержащая форматированный текст и такие элементы, как таблицы и списки.

Получите вкладку документа, используя Document.getTabs()[tabIndex].asDocumentTab() .

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

Методы

Метод	Тип возврата	Краткое описание
`addBookmark(position)`	`Bookmark`	Добавляет `Bookmark` в указанную `Position` .
`addFooter()`	`FooterSection`	Добавляет раздел нижнего колонтитула вкладки, если его нет.
`addHeader()`	`HeaderSection`	Добавляет раздел заголовка вкладки, если его нет.
`addNamedRange(name, range)`	`NamedRange`	Добавляет `NamedRange` , который представляет собой `Range` с именем и идентификатором, который можно использовать для последующего извлечения.
`getBody()`	`Body`	Получает `Body` вкладки.
`getBookmark(id)`	`Bookmark`	Получает `Bookmark` с заданным идентификатором.
`getBookmarks()`	`Bookmark[]`	Получает все объекты `Bookmark` на вкладке.
`getFooter()`	`FooterSection`	Извлекает нижний колонтитул вкладки, если он существует.
`getFootnotes()`	`Footnote[]`	Извлекает все элементы `Footnote` в теле вкладки.
`getHeader()`	`HeaderSection`	Получает раздел заголовка вкладки, если он существует.
`getNamedRangeById(id)`	`NamedRange`	Получает `NamedRange` с заданным идентификатором.
`getNamedRanges()`	`NamedRange[]`	Получает все объекты `NamedRange` на вкладке.
`getNamedRanges(name)`	`NamedRange[]`	Получает все объекты `NamedRange` на вкладке с заданным именем.
`newPosition(element, offset)`	`Position`	Создает новую `Position` , которая является ссылкой на местоположение на вкладке относительно определенного элемента.
`newRange()`	`RangeBuilder`	Создает построитель, используемый для создания объектов `Range` из элементов вкладки.

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

`addBookmark(position)`

Добавляет Bookmark в указанную Position .

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Параметры

Имя	Тип	Описание
`position`	`Position`	Положение новой закладки.

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

Bookmark — Новая закладка.

Авторизация

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

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

`addFooter()`

Добавляет раздел нижнего колонтитула вкладки, если его нет.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

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

FooterSection — нижний колонтитул вкладки.

Авторизация

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

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

`addHeader()`

Добавляет раздел заголовка вкладки, если его нет.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

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

HeaderSection — заголовок вкладки.

Авторизация

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

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

`addNamedRange(name, range)`

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

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

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

Параметры

Имя	Тип	Описание
`name`	`String`	Имя диапазона, которое не обязательно должно быть уникальным; Имена диапазонов должны содержать от 1 до 256 символов.
`range`	`Range`	Диапазон элементов, которые можно связать с именем; диапазон может быть результатом поиска или создан вручную с помощью `newRange()` .

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

NamedRange — NamedRange .

Авторизация

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

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

`getBody()`

Получает Body вкладки.

Вкладки могут содержать разделы разных типов (например, HeaderSection , FooterSection ). Активный раздел вкладки — Body .

Методы элемента в DocumentTab делегируют Body .

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

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

Body — раздел тела вкладки.

Авторизация

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

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

`getBookmark(id)`

Получает Bookmark с заданным идентификатором. Этот метод возвращает null , если на этой вкладке такой Bookmark не существует.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its position to the
// console. Otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Параметры

Имя	Тип	Описание
`id`	`String`	Идентификатор `Bookmark` .

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

Bookmark — Bookmark с заданным идентификатором или null , если на вкладке такой Bookmark не существует.

Авторизация

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

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

`getBookmarks()`

Получает все объекты Bookmark на вкладке.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

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

Bookmark[] — Массив объектов Bookmark на вкладке.

Авторизация

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

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

`getFooter()`

Извлекает нижний колонтитул вкладки, если он существует.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

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

FooterSection — нижний колонтитул вкладки.

Авторизация

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

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

`getFootnotes()`

Извлекает все элементы Footnote в теле вкладки.

Вызовы getFootnotes вызывают перебор элементов вкладки. Для больших вкладок избегайте ненужных вызовов этого метода.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

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

Footnote[] — сноски вкладки.

Авторизация

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

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

`getHeader()`

Получает раздел заголовка вкладки, если он существует.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

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

HeaderSection — заголовок вкладки.

Авторизация

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

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

`getNamedRangeById(id)`

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

Параметры

Имя	Тип	Описание
`id`	`String`	Идентификатор диапазона, уникальный в пределах вкладки.

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

NamedRange — NamedRange с заданным идентификатором или null , если такой диапазон не существует на вкладке.

Авторизация

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

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

`getNamedRanges()`

Получает все объекты NamedRange на вкладке.

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

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

NamedRange[] — Массив объектов NamedRange на вкладке, возможно, включающий несколько диапазонов с одинаковым именем.

Авторизация

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

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

`getNamedRanges(name)`

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

Параметры

Имя	Тип	Описание
`name`	`String`	Имя диапазона, которое не обязательно уникально.

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

NamedRange[] — Массив объектов NamedRange на вкладке с заданным именем.

Авторизация

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

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

`newPosition(element, offset)`

Создает новую Position , которая является ссылкой на местоположение на вкладке относительно определенного элемента. Курсор пользователя, помимо прочего, представлен как Position .

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
// TODO(developer): Replace the IDs with your own.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Параметры

Имя	Тип	Описание
`element`	`Element`	Элемент, содержащий вновь созданную `Position` для; это должен быть либо элемент `Text` , либо элемент-контейнер, например `Paragraph` .
`offset`	`Integer`	Для элементов `Text` — количество символов перед `Position` ; для других элементов — количество дочерних элементов до `Position` в одном элементе-контейнере.

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

Position — Новая Position .

Авторизация

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

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

`newRange()`

Создает построитель, используемый для создания объектов Range из элементов вкладки.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

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

RangeBuilder — Новый построитель.

Авторизация

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

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