Class DocumentTab

Добавляет 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('123abc').getTab('123abc').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());

Параметры

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

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

Авторизация

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

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

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

// 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('123abc').getTab('123abc').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

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

// 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('123abc').getTab('123abc').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

Добавляет 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.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

Параметры

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

NamedRange — NamedRange .

Авторизация

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

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

Получает 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('123abc').getTab('123abc').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

Получает Bookmark с заданным ID. Этот метод возвращает 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('123abc').getTab('123abc').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.');
}

Параметры

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

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

Авторизация

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

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

Получает все объекты 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('123abc').getTab('123abc').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

Получает нижнюю часть вкладки, если она существует.

// 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('123abc').getTab('123abc').asDocumentTab();

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

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

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

Авторизация

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

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

Извлекает все элементы 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('123abc').getTab('123abc').asDocumentTab();

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

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

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

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

Авторизация

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

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

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

// 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('123abc').getTab('123abc').asDocumentTab();

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

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

HeaderSection |null — Заголовок вкладки.

Авторизация

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

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

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

Параметры

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

NamedRange |null — NamedRange с заданным ID или null , если такого диапазона на вкладке нет.

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

Создает новый 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.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Параметры

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

Position — Новая Position .

Авторизация

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

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

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

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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