Class Body

Тело

Содержимое вкладки в документе Google Docs. Body может содержать элементы ListItem , Paragraph , Table и TableOfContents . Для получения дополнительной информации о структуре документа см. руководство по расширению Google Docs .

В Body обычно содержится всё содержимое вкладки, за исключением элементов HeaderSection , FooterSection и FootnoteSection .

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Page Break() Page Break Создает и добавляет новый Page Break .
append Page Break(pageBreak) Page Break Добавляет указанный Page Break .
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Добавляет данные Table .
clear() Body Очищает содержимое элемента.
copy() Body Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Heading Attributes(paragraphHeading) Object Получает набор атрибутов для указанного Paragraph Heading .
get Images() Inline Image[] |null Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] |null Извлекает все List Items содержащиеся в разделе.
get Margin Bottom() Number|null Извлекает нижний отступ в пунктах.
get Margin Left() Number|null Извлекает левый край в пунктах.
get Margin Right() Number|null Восстанавливает правый край.
get Margin Top() Number|null Извлекает верхний отступ.
get Num Children() Integer Получает количество детей.
get Page Height() Number|null Получает высоту страницы в пунктах.
get Page Width() Number|null Извлекает ширину страницы в пунктах.
get Paragraphs() Paragraph[] |null Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element |null Получает родительский элемент элемента.
get Tables() Table[] |null Извлекает все Tables содержащиеся в данном разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Page Break(childIndex) Page Break Создает и вставляет новый Page Break по указанному индексу.
insert Page Break(childIndex, pageBreak) Page Break Вставляет заданный Page Break по указанному индексу.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
remove Child(child) Body Удаляет указанный дочерний элемент.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Body Задает атрибуты элемента.
set Heading Attributes(paragraphHeading, attributes) Body Задает атрибуты для указанного Paragraph Heading .
set Margin Bottom(marginBottom) Body Задает нижний отступ в пунктах.
set Margin Left(marginLeft) Body Задает левый отступ в пунктах.
set Margin Right(marginRight) Body Устанавливает правый отступ в пунктах.
set Margin Top(marginTop) Body Устанавливает верхний отступ.
set Page Height(pageHeight) Body Задает высоту страницы в пунктах.
set Page Width(pageWidth) Body Задает ширину страницы в пунктах.
set Text(text) Body Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Body Задает выравнивание текста.

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

appendHorizontalRule()

Создает и добавляет новый HorizontalRule .

Правило HorizontalRule будет заключено в новый Paragraph .

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

HorizontalRule — Новая горизонтальная линия.

Авторизация

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

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

appendImage(image)

Создает и добавляет новый InlineImage из указанного блока изображений.

Изображение будет размещено в новом Paragraph .

Параметры

Имя Тип Описание
image Blob Source Данные изображения.

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

InlineImage — Добавляемое изображение.

Авторизация

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

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

appendImage(image)

Добавляет заданное InlineImage .

InlineImage будет помещено в новый Paragraph .

Используйте эту версию appendImage при добавлении копии существующего InlineImage .

Параметры

Имя Тип Описание
image Inline Image Данные изображения.

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

InlineImage — Добавляемое изображение.

Авторизация

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

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

appendListItem(listItem)

Добавляет заданный ListItem .

Используйте эту версию метода appendListItem при добавлении копии существующего ListItem .

Параметры

Имя Тип Описание
list Item List Item Элемент списка, который нужно добавить.

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

ListItem — Добавляемый элемент списка.

Авторизация

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

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

appendListItem(text)

Создает и добавляет новый ListItem содержащий указанное текстовое содержимое.

Последовательные элементы списка добавляются как часть одного и того же списка.

Параметры

Имя Тип Описание
text String Текстовое содержимое элемента списка.

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

ListItem — Новый элемент списка.

Авторизация

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

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

appendPageBreak()

Создает и добавляет новый PageBreak .

Разрыв PageBreak будет заключен в новый Paragraph .

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

PageBreak — новый способ разрыва страницы.

Авторизация

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

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

appendPageBreak(pageBreak)

Добавляет заданный PageBreak .

Разрыв PageBreak будет заключен в новый Paragraph .

Используйте эту версию функции appendPageBreak при добавлении копии существующего PageBreak .

Параметры

Имя Тип Описание
page Break Page Break Разрыв страницы для добавления.

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

PageBreak — Дополнительный разрыв страницы.

Авторизация

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

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

appendParagraph(paragraph)

Добавляет данный Paragraph .

Используйте эту версию функции appendParagraph при добавлении копии существующего Paragraph .

Параметры

Имя Тип Описание
paragraph Paragraph Дополняемый абзац.

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

Paragraph — Прилагаемый абзац.

Авторизация

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

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

appendParagraph(text)

Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.

Параметры

Имя Тип Описание
text String Содержание текста абзаца.

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

Paragraph — Новый абзац.

Авторизация

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

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

appendTable()

Создает и добавляет новую Table .

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

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

Table — Новый стол.

Авторизация

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

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

appendTable(cells)

Добавляет новую Table содержащую TableCell для каждого указанного строкового значения.

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

Параметры

Имя Тип Описание
cells String[][] Текстовое содержимое ячеек таблицы, которое необходимо добавить в новую таблицу.

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

Table — Прилагаемая таблица.

Авторизация

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

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

appendTable(table)

Добавляет данные Table .

Используйте эту версию метода appendTable при добавлении копии существующей Table . Этот метод также добавит пустой абзац после таблицы, поскольку документы Google Docs не могут заканчиваться таблицей.

Параметры

Имя Тип Описание
table Table Таблица для добавления.

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

Table — Прилагаемая таблица.

Авторизация

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

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

clear()

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

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

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

copy()

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

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

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

Body — Новый текст.

Авторизация

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

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

editAsText()

Получает 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 — текстовая версия текущего элемента

findElement(elementType)

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

Параметры

Имя Тип Описание
element Type Element Type Тип элемента для поиска.

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

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

Авторизация

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

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

findElement(elementType, from)

Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного 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;
  }
}

Параметры

Имя Тип Описание
element Type Element Type Тип элемента для поиска.
from Range Element Результаты поиска, из которых следует начинать поиск.

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

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

Авторизация

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

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

findText(searchPattern)

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

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

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

Параметры

Имя Тип Описание
search Pattern String шаблон для поиска

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

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

Авторизация

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

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

findText(searchPattern, from)

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

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

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

Параметры

Имя Тип Описание
search Pattern String шаблон для поиска
from Range Element Результаты поиска, из которых следует осуществлять поиск.

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

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

Авторизация

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

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

getAttributes()

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

В результате получается объект, содержащий свойство для каждого допустимого атрибута элемента, где каждое имя свойства соответствует элементу в перечислении 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

getChild(childIndex)

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

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.');
}

Параметры

Имя Тип Описание
child Index Integer Индекс дочернего элемента, который необходимо получить.

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

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

Авторизация

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

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

getChildIndex(child)

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

Параметры

Имя Тип Описание
child Element Дочерний элемент, для которого необходимо получить индекс.

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

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

Авторизация

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

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

getHeadingAttributes(paragraphHeading)

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

Параметры

Имя Тип Описание
paragraph Heading Paragraph Heading Заголовок, атрибуты которого необходимо получить.

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

Object — Карта атрибутов и их текущих значений.

Авторизация

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

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

getImages()

Извлекает все InlineImages содержащиеся в разделе.

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

InlineImage[] |null — Изображения раздела.

Авторизация

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

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

getListItems()

Извлекает все ListItems содержащиеся в разделе.

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

ListItem[] |null — Раздел списка элементов.

Авторизация

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

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

getMarginBottom()

Извлекает нижний отступ в пунктах.

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

Number|null — Нижний край, в пунктах.

Авторизация

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

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

getMarginLeft()

Извлекает левый край в пунктах.

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

Number|null — Левое поле, в пунктах.

Авторизация

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

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

getMarginRight()

Восстанавливает правый край.

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

Number|null — Правое поле, в пунктах.

Авторизация

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

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

getMarginTop()

Извлекает верхний отступ.

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

Number|null — Верхний край, в пунктах.

Авторизация

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

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

getNumChildren()

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

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

getPageHeight()

Получает высоту страницы в пунктах.

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

Number|null — Высота страницы в пунктах.

Авторизация

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

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

getPageWidth()

Извлекает ширину страницы в пунктах.

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

Number|null — Ширина страницы в пунктах.

Авторизация

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

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

getParagraphs()

Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).

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

Paragraph[] |null — Раздел параграфов.

Авторизация

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

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

getParent()

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

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

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

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

Авторизация

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

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

getTables()

Извлекает все Tables содержащиеся в данном разделе.

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

Table[] |null — Таблицы разделов.

Авторизация

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

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

getText()

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

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

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

Авторизация

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

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

getTextAlignment()

Получает выравнивание текста. Доступные типы выравнивания: 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

getType()

Получает тип элемента 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

insertHorizontalRule(childIndex)

Создает и вставляет новый элемент HorizontalRule по указанному индексу.

Правило HorizontalRule будет заключено в новый Paragraph .

Параметры

Имя Тип Описание
child Index Integer Индекс, по которому следует вставить элемент.

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

HorizontalRule — Новая горизонтальная линия.

Авторизация

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

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

insertImage(childIndex, image)

Создает и вставляет InlineImage из указанного блока изображений по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, по которому следует вставить элемент.
image Blob Source Данные изображения.

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

InlineImage — Вставляемое встроенное изображение.

Авторизация

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

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

insertImage(childIndex, image)

Вставляет указанное InlineImage по указанному индексу.

Изображение будет размещено в новом Paragraph .

Параметры

Имя Тип Описание
child Index Integer Индекс, по которому следует вставить элемент.
image Inline Image Изображение для вставки.

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

InlineImage — Вставляемое встроенное изображение.

Авторизация

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

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

insertListItem(childIndex, listItem)

Вставляет заданный ListItem по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
list Item List Item Элемент списка для вставки.

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

ListItem — Вставленный элемент списка.

Авторизация

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

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

insertListItem(childIndex, text)

Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
text String Текстовое содержимое элемента списка.

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

ListItem — Новый элемент списка.

Авторизация

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

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

insertPageBreak(childIndex)

Создает и вставляет новый PageBreak по указанному индексу.

Разрыв PageBreak будет заключен в новый Paragraph .

Параметры

Имя Тип Описание
child Index Integer Индекс, по которому следует вставить элемент.

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

PageBreak — новый способ разрыва страницы.

Авторизация

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

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

insertPageBreak(childIndex, pageBreak)

Вставляет заданный PageBreak по указанному индексу.

Разрыв PageBreak будет заключен в новый Paragraph .

Параметры

Имя Тип Описание
child Index Integer Индекс, по которому следует вставить элемент.
page Break Page Break Разрыв страницы для вставки.

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

PageBreak — Вставленный разрыв страницы.

Авторизация

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

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

insertParagraph(childIndex, paragraph)

Вставляет указанный Paragraph по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
paragraph Paragraph Абзац для вставки.

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

Paragraph — Вставленный абзац.

Авторизация

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

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

insertParagraph(childIndex, text)

Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
text String Содержание текста абзаца.

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

Paragraph — Новый абзац.

Авторизация

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

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

insertTable(childIndex)

Создает и вставляет новую Table по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.

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

Table — Новый стол.

Авторизация

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

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

insertTable(childIndex, cells)

Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
cells String[][] Текстовое содержимое ячеек таблицы, которое необходимо добавить в новую таблицу.

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

Table — Новый стол.

Авторизация

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

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

insertTable(childIndex, table)

Вставляет заданную Table по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer Индекс, в который следует вставить.
table Table Таблица для вставки.

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

Table — Вставленная таблица.

Авторизация

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

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

removeChild(child)

Удаляет указанный дочерний элемент.

Параметры

Имя Тип Описание
child Element Дочерний элемент, который нужно удалить.

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

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

Авторизация

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

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

replaceText(searchPattern, replacement)

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

Шаблон поиска передается в виде строки, а не объекта регулярного выражения 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');

Параметры

Имя Тип Описание
search Pattern String шаблон регулярного выражения для поиска
replacement String текст, который следует использовать в качестве замены

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

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

Авторизация

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

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

setAttributes(attributes)

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

Указанный параметр 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);

Параметры

Имя Тип Описание
attributes Object Атрибуты элемента.

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

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

Авторизация

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

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

setHeadingAttributes(paragraphHeading, attributes)

Задает атрибуты для указанного ParagraphHeading .

Параметры

Имя Тип Описание
paragraph Heading Paragraph Heading Заголовок, для которого следует задать атрибуты.
attributes Object Карта атрибутов и значений, которые им следует присвоить.

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

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

Авторизация

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

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

setMarginBottom(marginBottom)

Задает нижний отступ в пунктах.

Параметры

Имя Тип Описание
margin Bottom Number Нижний предел, в пунктах.

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

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

Авторизация

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

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

setMarginLeft(marginLeft)

Задает левый отступ в пунктах.

Параметры

Имя Тип Описание
margin Left Number Левое поле, в пунктах.

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

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

Авторизация

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

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

setMarginRight(marginRight)

Устанавливает правый отступ в пунктах.

Параметры

Имя Тип Описание
margin Right Number Правое поле.

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

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

Авторизация

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

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

setMarginTop(marginTop)

Устанавливает верхний отступ.

Параметры

Имя Тип Описание
margin Top Number Верхний предел, в пунктах.

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

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

Авторизация

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

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

setPageHeight(pageHeight)

Задает высоту страницы в пунктах.

Параметры

Имя Тип Описание
page Height Number Высота страницы в пунктах.

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

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

Авторизация

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

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

setPageWidth(pageWidth)

Задает ширину страницы в пунктах.

Параметры

Имя Тип Описание
page Width Number Ширина страницы в пунктах.

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

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

Авторизация

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

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

setText(text)

Преобразует содержимое в обычный текст.

Примечание: существующее содержимое удалено.

Параметры

Имя Тип Описание
text String Новое текстовое содержание.

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

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

Авторизация

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

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

setTextAlignment(textAlignment)

Задает выравнивание текста. Доступные типы выравнивания: 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);

Параметры

Имя Тип Описание
text Alignment Text Alignment тип выравнивания текста, который следует применить

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

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

Авторизация

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

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

Устаревшие методы