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

Class Body

Содержимое вкладки в документе Google Docs. Body может содержать элементы List Item , Paragraph , Table и Table Of Contents . Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .

Body обычно содержит все содержимое вкладки, за исключением Header Section , Footer Section и любых элементов Footnote Section .

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` из указанного BLOB-объекта изображения.
`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`	Ищет в содержимом элемента потомка указанного типа.
`find Element(elementType, from)`	`Range Element`	Ищет в содержимом элемента потомка указанного типа, начиная с указанного `Range Element` .
`find Text(searchPattern)`	`Range Element`	Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
`find Text(searchPattern, from)`	`Range Element`	Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
`get Attributes()`	`Object`	Получает атрибуты элемента.
`get Child(childIndex)`	`Element`	Извлекает дочерний элемент по указанному дочернему индексу.
`get Child Index(child)`	`Integer`	Получает дочерний индекс для указанного дочернего элемента.
`get Heading Attributes(paragraphHeading)`	`Object`	Извлекает набор атрибутов для предоставленного `Paragraph Heading` .
`get Images()`	`Inline Image[]`	Извлекает все `Inline Images` содержащиеся в разделе.
`get List Items()`	`List Item[]`	Извлекает все `List Items` содержащиеся в разделе.
`get Margin Bottom()`	`Number`	Получает нижнее поле в пунктах.
`get Margin Left()`	`Number`	Получает левое поле в пунктах.
`get Margin Right()`	`Number`	Получает правое поле.
`get Margin Top()`	`Number`	Получает верхнее поле.
`get Num Children()`	`Integer`	Получает количество детей.
`get Page Height()`	`Number`	Получает высоту страницы в пунктах.
`get Page Width()`	`Number`	Получает ширину страницы в пунктах.
`get Paragraphs()`	`Paragraph[]`	Извлекает все `Paragraphs` содержащиеся в разделе (включая `List Items` ).
`get Parent()`	`Container Element`	Извлекает родительский элемент элемента.
`get Tables()`	`Table[]`	Извлекает все `Tables` содержащиеся в разделе.
`get Text()`	`String`	Получает содержимое элемента в виде текстовой строки.
`get Text Alignment()`	`Text Alignment`	Получает выравнивание текста.
`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`	Устанавливает выравнивание текста.

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

Метод	Тип возврата	Краткое описание
`get Footnotes()`	`Footnote[]`	Извлекает все `Footnotes` содержащиеся в разделе.
`get Link Url()`	`String`	Получает URL-адрес ссылки.
`get Next Sibling()`	`Element`	Извлекает следующий родственный элемент элемента.
`get Previous Sibling()`	`Element`	Извлекает предыдущий родственный элемент элемента.
`is At Document End()`	`Boolean`	Определяет, находится ли элемент в конце `Document` .
`set Link Url(url)`	`Body`	Устанавливает URL-адрес ссылки.

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

`append Horizontal Rule()`

Создает и добавляет новое Horizontal Rule .

Horizontal Rule будет содержаться в новом Paragraph .

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

Horizontal Rule — новое горизонтальное правило.

Авторизация

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

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

`append Image(image)`

Создает и добавляет новое Inline Image из указанного BLOB-объекта изображения.

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

Параметры

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

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

Inline Image — добавленное изображение.

Авторизация

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

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

`append Image(image)`

Добавляет данное Inline Image .

Inline Image будет содержаться в новом Paragraph .

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

Параметры

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

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

Inline Image — добавленное изображение.

Авторизация

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

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

`append List Item(listItem)`

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

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

Параметры

Имя	Тип	Описание
`list Item`	`List Item`	Добавляемый элемент списка.

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

List Item — добавленный элемент списка.

Авторизация

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

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

`append List Item(text)`

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

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

Параметры

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

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

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

Авторизация

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

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

`append Page Break()`

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

Page Break будет содержаться в новом Paragraph .

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

Page Break — новый разрыв страницы.

Авторизация

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

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

`append Page Break(pageBreak)`

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

Page Break будет содержаться в новом Paragraph .

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

Параметры

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

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

Page Break — добавленный разрыв страницы.

Авторизация

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

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

`append Paragraph(paragraph)`

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

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

Параметры

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

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

Paragraph — добавленный абзац.

Авторизация

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

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

`append Paragraph(text)`

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

Параметры

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

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

Paragraph — Новый параграф.

Авторизация

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

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

`append Table()`

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

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

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

Table — Новая таблица.

Авторизация

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

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

`append Table(cells)`

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

Параметры

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

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

Table — добавленная таблица.

Авторизация

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

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

`append Table(table)`

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

Используйте эту версию append Table при добавлении копии существующей 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

`edit As Text()`

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

Используйте edit As Text для управления содержимым элементов в виде форматированного текста. Режим edit As Text игнорирует нетекстовые элементы (такие как Inline Image и Horizontal Rule ).

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

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

`find Element(elementType)`

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

Параметры

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

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

Range Element — результат поиска, указывающий положение элемента поиска.

Авторизация

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

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

`find Element(elementType, from)`

Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .

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`	Результат поиска, по которому осуществляется поиск.

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

Range Element — результат поиска, указывающий следующую позицию элемента поиска.

Авторизация

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

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

`find Text(searchPattern)`

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

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

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

Параметры

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

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

Range Element — результат поиска, указывающий позицию искомого текста, или значение NULL, если совпадений нет.

Авторизация

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

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

`find Text(searchPattern, from)`

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

Параметры

Имя	Тип	Описание
`search Pattern`	`String`	шаблон для поиска
`from`	`Range Element`	результат поиска для поиска

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

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

Авторизация

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

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

`get Attributes()`

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

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

`get Child(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

`get Child Index(child)`

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

Параметры

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

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

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

Авторизация

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

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

`get Heading Attributes(paragraphHeading)`

Извлекает набор атрибутов для предоставленного Paragraph Heading .

Параметры

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

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

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

Авторизация

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

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

`get Images()`

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

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

Inline Image[] — изображения раздела.

Авторизация

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

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

`get List Items()`

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

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

List Item[] — Элементы списка раздела.

Авторизация

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

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

`get Margin Bottom()`

Получает нижнее поле в пунктах.

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

Number — нижнее поле в пунктах.

Авторизация

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

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

`get Margin Left()`

Получает левое поле в пунктах.

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

Number — левое поле в пунктах.

Авторизация

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

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

`get Margin Right()`

Получает правое поле.

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

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

Авторизация

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

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

`get Margin Top()`

Получает верхнее поле.

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

Number — верхнее поле в пунктах.

Авторизация

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

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

`get Num Children()`

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

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

`get Page Height()`

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

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

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

Авторизация

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

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

`get Page Width()`

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

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

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

Авторизация

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

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

`get Paragraphs()`

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

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

Paragraph[] — Абзацы раздела.

Авторизация

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

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

`get Parent()`

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

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

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

Container Element — родительский элемент.

Авторизация

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

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

`get Tables()`

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

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

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

Авторизация

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

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

`get Text()`

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

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

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

Авторизация

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

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

`get Text Alignment()`

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

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

Text Alignment — тип выравнивания текста или null , если текст содержит несколько типов выравнивания текста или если выравнивание текста никогда не устанавливалось.

Авторизация

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

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

`get Type()`

Получает Element Type элемента.

Используйте get Type() чтобы определить точный тип данного элемента.

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

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

Element Type — тип элемента.

Авторизация

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

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

`insert Horizontal Rule(childIndex)`

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

Horizontal Rule будет содержаться в новом Paragraph .

Параметры

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

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

Horizontal Rule — новое горизонтальное правило.

Авторизация

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

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

`insert Image(childIndex, image)`

Создает и вставляет Inline Image из указанного большого двоичного объекта изображения по указанному индексу.

Параметры

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

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

Inline Image — вставленное встроенное изображение.

Авторизация

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

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

`insert Image(childIndex, image)`

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

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

Параметры

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

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

Inline Image — вставленное встроенное изображение.

Авторизация

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

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

`insert List Item(childIndex, listItem)`

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

Параметры

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

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

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

Авторизация

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

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

`insert List Item(childIndex, text)`

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

Параметры

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

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

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

Авторизация

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

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

`insert Page Break(childIndex)`

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

Page Break будет содержаться в новом Paragraph .

Параметры

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

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

Page Break — новый разрыв страницы.

Авторизация

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

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

`insert Page Break(childIndex, pageBreak)`

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

Page Break будет содержаться в новом Paragraph .

Параметры

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

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

Page Break — вставленный разрыв страницы.

Авторизация

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

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

`insert Paragraph(childIndex, paragraph)`

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

Параметры

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

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

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

Авторизация

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

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

`insert Paragraph(childIndex, text)`

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

Параметры

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

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

Paragraph — Новый параграф.

Авторизация

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

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

`insert Table(childIndex)`

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

Параметры

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

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

Table — Новая таблица.

Авторизация

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

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

`insert Table(childIndex, cells)`

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

Параметры

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

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

Table — Новая таблица.

Авторизация

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

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

`insert Table(childIndex, table)`

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

Параметры

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

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

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

Авторизация

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

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

`remove Child(child)`

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

Параметры

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

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

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

Авторизация

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

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

`replace Text(searchPattern, replacement)`

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

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

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

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

`set Attributes(attributes)`

Устанавливает атрибуты элемента.

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

`set Heading Attributes(paragraphHeading, attributes)`

Устанавливает атрибуты для предоставленного Paragraph Heading .

Параметры

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

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

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

Авторизация

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

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

`set Margin Bottom(marginBottom)`

Устанавливает нижнее поле в пунктах.

Параметры

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

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

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

Авторизация

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

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

`set Margin Left(marginLeft)`

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

Параметры

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

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

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

Авторизация

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

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

`set Margin Right(marginRight)`

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

Параметры

Имя	Тип	Описание
`margin Right`	`Number`	Правильный запас.

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

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

Авторизация

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

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

`set Margin Top(marginTop)`

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

Параметры

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

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

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

Авторизация

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

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

`set Page Height(pageHeight)`

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

Параметры

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

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

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

Авторизация

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

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

`set Page Width(pageWidth)`

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

Параметры

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

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

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

Авторизация

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

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

`set Text(text)`

Устанавливает содержимое в виде обычного текста.

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

Параметры

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

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

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

Авторизация

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

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

`set Text Alignment(textAlignment)`

Устанавливает выравнивание текста. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT и Document App.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

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

`get Footnotes()`

Устарело. Этот элемент не может содержать Footnote .

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

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

Footnote[] — Сноски раздела.

Авторизация

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

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

`get Link Url()`

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

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

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

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

Авторизация

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

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

`get Next Sibling()`

Устарело. У этого элемента нет братьев и сестер.

Извлекает следующий родственный элемент элемента.

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

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

Element — следующий родственный элемент.

Авторизация

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

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

`get Previous Sibling()`

Устарело. У этого элемента нет братьев и сестер.

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

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

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

Element — предыдущий родственный элемент.

Авторизация

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

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

`is At Document End()`

Устарело. Этот метод ненадежен для Header Section .

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

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

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

Авторизация

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

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

`set Link Url(url)`

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

Устанавливает URL-адрес ссылки.

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес ссылки

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

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

Авторизация

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

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