Class TableOfContents

Очищает содержимое элемента.

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

TableOfContents — Текущий элемент.

Возвращает отсоединенную, глубокую копию текущего элемента.

Все дочерние элементы, присутствующие в новом элементе, также копируются. У нового элемента нет родителя.

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

TableOfContents — Новый вариант.

Авторизация

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

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

Получает Text версию текущего элемента для редактирования.

Используйте editAsText для редактирования содержимого элементов в виде форматированного текста. Режим editAsText игнорирует нетекстовые элементы (такие как InlineImage и HorizontalRule ).

Дочерние элементы, полностью находящиеся в пределах удаленного текстового диапазона, удаляются из элемента.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

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

Text — текстовая версия текущего элемента

Выполняет поиск в содержимом элемента потомка указанного типа.

Параметры

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

RangeElement |null — Результат поиска, указывающий позицию искомого элемента.

Авторизация

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

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

Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного RangeElement ).

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Параметры

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

RangeElement |null — Результат поиска, указывающий следующую позицию искомого элемента.

Авторизация

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

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

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

Некоторые функции регулярных выражений JavaScript поддерживаются не в полной мере, например, группы захвата и модификаторы режима.

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

Параметры

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

RangeElement |null — результат поиска, указывающий позицию искомого текста, или null, если совпадений нет.

Авторизация

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

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

Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.

Некоторые функции регулярных выражений JavaScript поддерживаются не в полной мере, например, группы захвата и модификаторы режима.

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

Параметры

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

RangeElement |null — результат поиска, указывающий следующую позицию искомого текста, или null, если совпадений нет.

Авторизация

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

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

Получает атрибуты элемента.

В результате получается объект, содержащий свойство для каждого допустимого атрибута элемента, где каждое имя свойства соответствует элементу в перечислении DocumentApp.Attribute .

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

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

Object — Атрибуты элемента.

Авторизация

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

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

Извлекает дочерний элемент по указанному индексу дочернего элемента.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Параметры

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

Element — дочерний элемент по указанному индексу.

Авторизация

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

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

Получает индекс дочернего элемента для указанного дочернего элемента.

Параметры

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

Integer — дочерний индекс.

Авторизация

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

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

Получает URL-адрес ссылки.

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

String|null — URL ссылки, или null, если элемент содержит несколько значений для этого атрибута.

Авторизация

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

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

Получает следующий соседний элемент.

Следующий элемент-близнец имеет того же родителя и следует за текущим элементом.

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

Element |null — Следующий соседний элемент.

Авторизация

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

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

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

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

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

Integer — количество детей.

Авторизация

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

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

Получает родительский элемент элемента.

Родительский элемент содержит текущий элемент.

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

ContainerElement |null — Родительский элемент.

Авторизация

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

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

Получает предыдущий соседний элемент.

Предыдущий соседний элемент имеет того же родителя и предшествует текущему элементу.

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

Element |null — Предыдущий соседний элемент.

Авторизация

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

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

Извлекает содержимое элемента в виде текстовой строки.

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

String — содержимое элемента в виде текстовой строки.

Авторизация

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

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

Получает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL , DocumentApp.TextAlignment.SUBSCRIPT и DocumentApp.TextAlignment.SUPERSCRIPT .

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

TextAlignment |null — тип выравнивания текста, или null если текст содержит несколько типов выравнивания или если выравнивание текста никогда не было задано.

Авторизация

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

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

Получает тип элемента ElementType ).

Используйте getType() для определения точного типа заданного элемента.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

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

ElementType — Тип элемента.

Авторизация

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

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

Определяет, находится ли элемент в конце Document .

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

Boolean — указывает, находится ли элемент в конце вкладки.

Авторизация

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

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

Удаляет элемент из родительского элемента.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

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

TableOfContents |null — Удалённый элемент.

Авторизация

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

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

Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.

Шаблон поиска передается в виде строки, а не объекта регулярного выражения JavaScript. Поэтому вам потребуется экранировать все обратные косые черты в шаблоне.

Этот метод использует библиотеку регулярных выражений RE2 от Google, что ограничивает поддерживаемый синтаксис .

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Параметры

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

Element — текущий элемент

Авторизация

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

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

Задает атрибуты элемента.

Указанный параметр attributes должен представлять собой объект, где каждое имя свойства является элементом перечисления DocumentApp.Attribute , а каждое значение свойства — новым значением, которое должно быть применено.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Параметры

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

TableOfContents — Текущий элемент.

Авторизация

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

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

Задает URL-адрес ссылки.

Параметры

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

TableOfContents — текущий элемент

Авторизация

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

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

Задает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL , DocumentApp.TextAlignment.SUBSCRIPT и DocumentApp.TextAlignment.SUPERSCRIPT .

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Параметры

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

TableOfContents — текущий элемент

Авторизация

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

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