Class ListItem

Пункт списка

Элемент, представляющий собой элемент списка. List Item — это Paragraph , связанный с идентификатором списка. List Item может содержать элементы Equation , Footnote , Horizontal Rule , Inline Drawing , Inline Image , Page Break » и Text . Для получения дополнительной информации о структуре документа см. руководство по расширению Google Docs .

List Items не могут содержать символы новой строки. Символы новой строки ("\n") преобразуются в символы переноса строки ("\r").

List Items с одинаковым идентификатором (ID) принадлежат одному и тому же списку и нумеруются соответствующим образом. List Items данного списка не обязательно должны располагаться рядом на вкладке или даже иметь один и тот же родительский элемент. Два элемента, принадлежащие одному и тому же списку, могут находиться в любом месте на вкладке, сохраняя при этом последовательную нумерацию, как показано в следующем примере:

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Методы

Метод Тип возвращаемого значения Краткое описание
add Positioned Image(image) Positioned Image Создает и вставляет новое Positioned Image из указанного блока изображений.
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Inline Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Inline Image(image) Inline Image Добавляет заданное Inline Image .
append Page Break() Page Break Создает и добавляет новый Page Break .
append Page Break(pageBreak) Page Break Добавляет указанный Page Break .
append Text(text) Text Создает и добавляет новый Text элемент с указанным содержимым.
append Text(text) Text Добавляет заданный Text элемент.
clear() List Item Очищает содержимое элемента.
copy() List Item Возвращает отсоединенную, глубокую копию текущего элемента.
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 Alignment() Horizontal Alignment |null Получает Horizontal Alignment .
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Glyph Type() Glyph Type |null Получает Glyph Type элемента списка.
get Heading() Paragraph Heading |null Извлекает Paragraph Heading .
get Indent End() Number|null Извлекает конечный отступ в пунктах.
get Indent First Line() Number|null Извлекает отступ первой строки в пунктах.
get Indent Start() Number|null Извлекает начальный отступ.
get Line Spacing() Number|null Извлекает межстрочный интервал в пунктах.
get Link Url() String|null Получает URL-адрес ссылки.
get List Id() String|null Получает идентификатор списка.
get Nesting Level() Integer Получает уровень вложенности элемента списка.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Positioned Image(id) Positioned Image Получает Positioned Image по его идентификатору.
get Positioned Images() Positioned Image[] Получает все объекты Positioned Image привязанные к абзацу.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Spacing After() Number|null Определяет расстояние после элемента в пунктах.
get Spacing Before() Number|null Извлекает отступ перед элементом в пунктах.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет Horizontal Rule по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Создает и вставляет новое Inline Image из указанного блока изображений по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert Page Break(childIndex) Page Break Создает и вставляет новый Page Break по указанному индексу.
insert Page Break(childIndex, pageBreak) Page Break Вставляет заданный Page Break по указанному индексу.
insert Text(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insert Text(childIndex, text) Text Вставляет заданный Text элемент по указанному индексу с указанным текстовым содержимым.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
is Left To Right() Boolean|null Извлекает настройку "слева направо".
merge() List Item |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Child(child) List Item Удаляет указанный дочерний элемент.
remove From Parent() List Item |null Удаляет элемент из родительского элемента.
remove Positioned Image(id) Boolean Удаляет Positioned Image по его идентификатору.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Alignment(alignment) List Item Задает Horizontal Alignment .
set Attributes(attributes) List Item Задает атрибуты элемента.
set Glyph Type(glyphType) List Item Задает Glyph Type для элемента списка.
set Heading(heading) List Item Задает Paragraph Heading .
set Indent End(indentEnd) List Item Задает отступ в конце строки в пунктах.
set Indent First Line(indentFirstLine) List Item Задает отступ первой строки в пунктах.
set Indent Start(indentStart) List Item Задает начальный отступ в пунктах.
set Left To Right(leftToRight) List Item Задает направление слева направо.
set Line Spacing(multiplier) List Item Задает межстрочный интервал в виде величины, указывающей количество строк, используемых для отступа.
set Link Url(url) List Item Задает URL-адрес ссылки.
set List Id(listItem) List Item Задает идентификатор списка.
set Nesting Level(nestingLevel) List Item Задает уровень вложенности элемента списка.
set Spacing After(spacingAfter) List Item Задает отступ после элемента в пунктах.
set Spacing Before(spacingBefore) List Item Задает отступ перед элементом в пунктах.
set Text(text) void Устанавливает содержимое элемента списка в виде текста.
set Text Alignment(textAlignment) List Item Задает выравнивание текста.

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

add Positioned Image(image)

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

Параметры

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

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

Positioned Image — новое позиционированное изображение

Авторизация

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

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

append Horizontal Rule()

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

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

Horizontal Rule — новая горизонтальная линейка

Авторизация

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

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

append Inline Image(image)

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

Параметры

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

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

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

Авторизация

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

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

append Inline Image(image)

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

Параметры

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

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

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

Авторизация

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

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

append Page Break()

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

Примечание: Page Breaks не могут находиться внутри Table Cells . Если текущий элемент находится внутри ячейки таблицы, будет сгенерировано исключение.

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

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

Авторизация

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

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

append Page Break(pageBreak)

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

Примечание: Page Breaks не могут находиться внутри Table Cells . Если текущий элемент находится внутри ячейки таблицы, будет сгенерировано исключение.

Параметры

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

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

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

Авторизация

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

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

append Text(text)

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

Параметры

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

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

Text — новый текстовый элемент

Авторизация

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

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

append Text(text)

Добавляет заданный Text элемент.

Параметры

Имя Тип Описание
text Text текстовый элемент для добавления

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

Text — добавленный текстовый элемент

Авторизация

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

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

clear()

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

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

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

copy()

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

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

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

List Item — Новый экземпляр.

Авторизация

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

  • 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 |null — Результат поиска, указывающий позицию искомого элемента.

Авторизация

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

  • 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 |null — Результат поиска, указывающий следующую позицию искомого элемента.

Авторизация

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

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

find Text(searchPattern)

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

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

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

Параметры

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

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

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

Авторизация

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

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

find Text(searchPattern, from)

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

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

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

Параметры

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

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

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

Авторизация

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

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

get Alignment()

Получает Horizontal Alignment .

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

Horizontal Alignment |null — выравнивание

Авторизация

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

  • 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 Glyph Type()

Получает Glyph Type элемента списка.

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

Glyph Type |null — тип глифа

Авторизация

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

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

get Heading()

Извлекает Paragraph Heading .

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

Paragraph Heading |null — заголовок

Авторизация

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

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

get Indent End()

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

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

Number|null — отступ в конце строки, в пунктах

Авторизация

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

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

get Indent First Line()

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

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

Number|null — отступ первой строки в пунктах

Авторизация

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

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

get Indent Start()

Извлекает начальный отступ.

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

Number|null — начальный отступ

Авторизация

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

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

get Line Spacing()

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

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

Number|null — межстрочный интервал в пунктах

Авторизация

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

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

get Link Url()

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

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

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

Авторизация

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

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

get List Id()

Получает идентификатор списка.

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

String|null — идентификатор списка

Авторизация

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

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

get Nesting Level()

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

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

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

Integer — уровень вложенности

Авторизация

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

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

get Next Sibling()

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

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

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

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

Авторизация

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

  • 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 Parent()

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

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

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

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

Авторизация

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

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

get Positioned Image(id)

Получает Positioned Image по его идентификатору.

Параметры

Имя Тип Описание
id String идентификатор изображения

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

Positioned Image — позиционированное изображение

Авторизация

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

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

get Positioned Images()

Получает все объекты Positioned Image привязанные к абзацу.

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

Positioned Image[] — список позиционированных изображений

Авторизация

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

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

get Previous Sibling()

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

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

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

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

Авторизация

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

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

get Spacing After()

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

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

Number|null — расстояние после элемента, в пунктах

Авторизация

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

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

get Spacing Before()

Извлекает отступ перед элементом в пунктах.

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

Number|null — расстояние перед элементом, в пунктах

Авторизация

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

  • 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 — тип выравнивания текста, или 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 по указанному индексу.

Параметры

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

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

Horizontal Rule — новый элемент горизонтальной линии

Авторизация

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

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

insert Inline 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 Inline Image(childIndex, image)

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

Параметры

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

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

Inline Image — вставляемый элемент встроенного изображения.

Авторизация

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

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

insert Page Break(childIndex)

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

Примечание: Page Breaks не могут находиться внутри Table Cells . Если текущий элемент находится внутри ячейки таблицы, будет сгенерировано исключение.

Параметры

Имя Тип Описание
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 Breaks не могут находиться внутри Table Cells . Если текущий элемент находится внутри ячейки таблицы, будет сгенерировано исключение.

Параметры

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

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

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

Авторизация

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

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

insert Text(childIndex, text)

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

Параметры

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

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

Text — новый текстовый элемент

Авторизация

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

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

insert Text(childIndex, text)

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

Параметры

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

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

Text — вставленный текстовый элемент

Авторизация

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

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

is At Document End()

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

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

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

Авторизация

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

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

is Left To Right()

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

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

Boolean|null — настройка слева направо

Авторизация

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

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

merge()

Объединяет элемент с предшествующим соседним элементом того же типа.

Объединять можно только элементы одного Element Type . Все дочерние элементы, содержащиеся в текущем элементе, перемещаются в предшествующий соседний элемент.

Текущий элемент удаляется из документа.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

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

List Item |null — Объединенный элемент.

Авторизация

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

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

remove Child(child)

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

Параметры

Имя Тип Описание
child Element дочерний элемент для удаления

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

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

Авторизация

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

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

remove From Parent()

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

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();
}

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

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

Авторизация

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

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

remove Positioned Image(id)

Удаляет Positioned Image по его идентификатору.

Параметры

Имя Тип Описание
id String

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

Boolean — было ли удалено указанное изображение или нет.

Авторизация

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

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

replace Text(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

set Alignment(alignment)

Задает Horizontal Alignment .

Параметры

Имя Тип Описание
alignment Horizontal Alignment горизонтальное выравнивание

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

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

Авторизация

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

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

set Attributes(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 Атрибуты элемента.

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

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

Авторизация

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

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

set Glyph Type(glyphType)

Задает Glyph Type для элемента списка.

Параметры

Имя Тип Описание
glyph Type Glyph Type тип глифа

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

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

Авторизация

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

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

set Heading(heading)

Задает Paragraph Heading .

Параметры

Имя Тип Описание
heading Paragraph Heading заголовок

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

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

Авторизация

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

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

set Indent End(indentEnd)

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

Параметры

Имя Тип Описание
indent End Number отступ в конце, в пунктах

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

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

Авторизация

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

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

set Indent First Line(indentFirstLine)

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

Параметры

Имя Тип Описание
indent First Line Number отступ первой строки, в пунктах

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

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

Авторизация

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

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

set Indent Start(indentStart)

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

Параметры

Имя Тип Описание
indent Start Number начальный отступ, в пунктах

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

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

Авторизация

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

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

set Left To Right(leftToRight)

Задает направление слева направо.

Параметры

Имя Тип Описание
left To Right Boolean слева направо

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

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

Авторизация

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

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

set Line Spacing(multiplier)

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

Параметры

Имя Тип Описание
multiplier Number количество строк

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

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

Авторизация

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

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

set Link Url(url)

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

Параметры

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

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

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

Авторизация

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

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

set List Id(listItem)

Задает идентификатор списка.

Идентификатор списка устанавливается на одно и то же значение для указанного List Item . Оба List Items будут рассматриваться как члены одного и того же списка.

Параметры

Имя Тип Описание
list Item List Item элемент списка, идентификатор которого следует использовать в списке.

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

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

Авторизация

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

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

set Nesting Level(nestingLevel)

Задает уровень вложенности элемента списка.

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

Параметры

Имя Тип Описание
nesting Level Integer уровень гнездования

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

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

Авторизация

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

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

set Spacing After(spacingAfter)

Задает отступ после элемента в пунктах.

Параметры

Имя Тип Описание
spacing After Number Отступ после элемента, в пунктах

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

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

Авторизация

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

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

set Spacing Before(spacingBefore)

Задает отступ перед элементом в пунктах.

Параметры

Имя Тип Описание
spacing Before Number Отступ перед элементом, в пунктах

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

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

Авторизация

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

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

set Text(text)

Устанавливает содержимое элемента списка в виде текста.

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

Параметры

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

Авторизация

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

  • 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 тип выравнивания текста, который следует применить

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

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

Авторизация

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

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