Class ListItem

Пункт списка

Элемент, представляющий элемент списка. ListItem — это Paragraph , связанный с идентификатором списка. ListItem может содержать элементы Equation , Footnote , HorizontalRule , InlineDrawing , InlineImage , PageBreak и Text . Дополнительные сведения о структуре документа см. в руководстве по расширению Документов Google .

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

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

var body = DocumentApp.getActiveDocument().getBody();

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Методы

Метод Тип возврата Краткое описание
addPositionedImage(image) PositionedImage Создает и вставляет новый объект PositionedImage из указанного большого двоичного объекта изображения.
appendHorizontalRule() HorizontalRule Создает и добавляет новое HorizontalRule .
appendInlineImage(image) InlineImage Создает и добавляет новый InlineImage из указанного большого двоичного объекта изображения.
appendInlineImage(image) InlineImage Добавляет заданный InlineImage .
appendPageBreak() PageBreak Создает и добавляет новый PageBreak .
appendPageBreak(pageBreak) PageBreak Добавляет заданный PageBreak .
appendText(text) Text Создает и добавляет новый элемент Text с указанным содержимым.
appendText(text) Text Добавляет заданный Text элемент.
clear() ListItem Очищает содержимое элемента.
copy() ListItem Возвращает отдельную, глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, используя регулярные выражения.
findText(searchPattern, from) RangeElement Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
getAlignment() HorizontalAlignment Извлекает HorizontalAlignment .
getAttributes() Object Извлекает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Извлекает дочерний индекс для указанного дочернего элемента.
getGlyphType() GlyphType Извлекает GlyphType элемента списка.
getHeading() ParagraphHeading Извлекает заголовок ParagraphHeading .
getIndentEnd() Number Получает отступ конца в пунктах.
getIndentFirstLine() Number Извлекает отступ первой строки в пунктах.
getIndentStart() Number Получает начальный отступ.
getLineSpacing() Number Получает межстрочный интервал в пунктах.
getLinkUrl() String Получает URL-адрес ссылки.
getListId() String Извлекает идентификатор списка.
getNestingLevel() Integer Получает уровень вложенности элемента списка.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPositionedImage(id) PositionedImage Получает PositionedImage по идентификатору изображения.
getPositionedImages() PositionedImage[] Получает все объекты PositionedImage , привязанные к абзацу.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getSpacingAfter() Number Получает интервал после элемента в пунктах.
getSpacingBefore() Number Извлекает интервал перед элементом в пунктах.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Извлекает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет HorizontalRule по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Создает и вставляет новый InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertPageBreak(childIndex) PageBreak Создает и вставляет новый PageBreak по указанному индексу.
insertPageBreak(childIndex, pageBreak) PageBreak Вставляет заданный PageBreak по указанному индексу.
insertText(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insertText(childIndex, text) Text Вставляет данный элемент Text по указанному индексу с указанным текстовым содержимым.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
isLeftToRight() Boolean Извлекает настройку слева направо.
merge() ListItem Объединяет элемент с предыдущим элементом того же типа.
removeChild(child) ListItem Удаляет указанный дочерний элемент.
removeFromParent() ListItem Удаляет элемент из его родителя.
removePositionedImage(id) Boolean Удаляет PositionedImage по идентификатору изображения.
replaceText(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAlignment(alignment) ListItem Устанавливает HorizontalAlignment .
setAttributes(attributes) ListItem Устанавливает атрибуты элемента.
setGlyphType(glyphType) ListItem Устанавливает GlyphType элемента списка.
setHeading(heading) ListItem Устанавливает заголовок ParagraphHeading .
setIndentEnd(indentEnd) ListItem Устанавливает конечный отступ в пунктах.
setIndentFirstLine(indentFirstLine) ListItem Устанавливает отступ первой строки в пунктах.
setIndentStart(indentStart) ListItem Устанавливает начальный отступ в пунктах.
setLeftToRight(leftToRight) ListItem Устанавливает настройку слева направо.
setLineSpacing(multiplier) ListItem Устанавливает межстрочный интервал как количество, указывающее количество строк, используемых для интервала.
setLinkUrl(url) ListItem Устанавливает URL-адрес ссылки.
setListId(listItem) ListItem Устанавливает идентификатор списка.
setNestingLevel(nestingLevel) ListItem Устанавливает уровень вложенности элемента списка.
setSpacingAfter(spacingAfter) ListItem Устанавливает интервал после элемента в пунктах.
setSpacingBefore(spacingBefore) ListItem Устанавливает интервал перед элементом в пунктах.
setText(text) void Устанавливает содержимое элемента списка в виде текста.
setTextAlignment(textAlignment) ListItem Устанавливает выравнивание текста.

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

addPositionedImage(image)

Создает и вставляет новый объект PositionedImage из указанного большого двоичного объекта изображения.

Параметры

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

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

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

Авторизация

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

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

appendHorizontalRule()

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

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

HorizontalRule — новое горизонтальное правило

Авторизация

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

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

appendInlineImage(image)

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

Параметры

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

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

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

Авторизация

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

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

appendInlineImage(image)

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

Параметры

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

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

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

Авторизация

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

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

appendPageBreak()

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

Примечание. PageBreaks не может содержаться в TableCells . Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.

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

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

Авторизация

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

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

appendPageBreak(pageBreak)

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

Примечание. PageBreaks не может содержаться в TableCells . Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.

Параметры

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

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

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

Авторизация

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

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

appendText(text)

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

Параметры

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

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

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

Авторизация

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

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

appendText(text)

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

Параметры

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

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

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

Авторизация

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

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

clear()

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

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

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

copy()

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

Любые дочерние элементы, присутствующие в элементе, также копируются. Новый элемент не имеет родителя.

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

ListItem — новая копия.

Авторизация

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

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

editAsText()

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

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

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

var body = DocumentApp.getActiveDocument().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)

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

Параметры

Имя Тип Описание
elementType ElementType тип элемента для поиска

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

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

Авторизация

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

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

findElement(elementType, from)

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Параметры

Имя Тип Описание
elementType ElementType тип элемента для поиска
from RangeElement результат поиска для поиска

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

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

Авторизация

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

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

findText(searchPattern)

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

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

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

Параметры

Имя Тип Описание
searchPattern String образец для поиска

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

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

Авторизация

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

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

findText(searchPattern, from)

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

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

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

Параметры

Имя Тип Описание
searchPattern String образец для поиска
from RangeElement результат поиска для поиска

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

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

Авторизация

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

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

getAlignment()

Извлекает HorizontalAlignment .

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

HorizontalAlignment — выравнивание

Авторизация

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

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

getAttributes()

Извлекает атрибуты элемента.

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

var body = DocumentApp.getActiveDocument().getBody();

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

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

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

Авторизация

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

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

getChild(childIndex)

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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.");
}

Параметры

Имя Тип Описание
childIndex 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

getGlyphType()

Извлекает GlyphType элемента списка.

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

GlyphType — тип глифа

Авторизация

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

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

getHeading()

Извлекает заголовок ParagraphHeading .

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

ParagraphHeading — заголовок

Авторизация

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

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

getIndentEnd()

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

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

Number — конечный отступ, в пунктах

Авторизация

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

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

getIndentFirstLine()

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

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

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

Авторизация

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

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

getIndentStart()

Получает начальный отступ.

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

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

Авторизация

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

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

getLineSpacing()

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

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

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

Авторизация

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

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

getLinkUrl()

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

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

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

Авторизация

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

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

getListId()

Извлекает идентификатор списка.

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

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

Авторизация

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

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

getNestingLevel()

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

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

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

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

Авторизация

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

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

getNextSibling()

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

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

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

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

Авторизация

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

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

getNumChildren()

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

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

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

Авторизация

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

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

getParent()

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

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

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

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

Авторизация

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

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

getPositionedImage(id)

Получает PositionedImage по идентификатору изображения.

Параметры

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

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

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

Авторизация

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

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

getPositionedImages()

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

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

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

Авторизация

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

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

getPreviousSibling()

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

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

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

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

Авторизация

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

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

getSpacingAfter()

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

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

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

Авторизация

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

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

getSpacingBefore()

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

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

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

Авторизация

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

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

Авторизация

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

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

getType()

Извлекает ElementType элемента.

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

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var 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 по указанному индексу.

Параметры

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

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

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

Авторизация

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

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

insertInlineImage(childIndex, image)

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

Параметры

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

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

InlineImage — вставленный встроенный элемент изображения

Авторизация

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

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

insertInlineImage(childIndex, image)

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

Параметры

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

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

InlineImage — вставленный встроенный элемент изображения

Авторизация

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

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

insertPageBreak(childIndex)

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

Примечание. PageBreaks не может содержаться в TableCells . Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.

Параметры

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

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

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

Авторизация

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

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

insertPageBreak(childIndex, pageBreak)

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

Примечание. PageBreaks не может содержаться в TableCells . Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.

Параметры

Имя Тип Описание
childIndex Integer индекс, по которому нужно вставить элемент
pageBreak PageBreak разрыв страницы для вставки

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

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

Авторизация

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

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

insertText(childIndex, text)

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

Параметры

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

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

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

Авторизация

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

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

insertText(childIndex, text)

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

Параметры

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

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

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

Авторизация

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

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

isAtDocumentEnd()

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

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

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

Авторизация

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

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

isLeftToRight()

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

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

Boolean — установка слева направо

Авторизация

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

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

merge()

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

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

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

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

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

ListItem — объединенный элемент.

Авторизация

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

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

removeChild(child)

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

Параметры

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

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

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

Авторизация

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

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

removeFromParent()

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

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

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

ListItem — удаленный элемент.

Авторизация

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

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

removePositionedImage(id)

Удаляет PositionedImage по идентификатору изображения.

Параметры

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

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

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

Авторизация

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

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

replaceText(searchPattern, replacement)

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

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

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

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

var body = DocumentApp.getActiveDocument().getBody();

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

Параметры

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

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

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

Авторизация

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

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

setAlignment(alignment)

Устанавливает HorizontalAlignment .

Параметры

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

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

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

Авторизация

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

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

setAttributes(attributes)

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

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

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

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

Параметры

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

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

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

Авторизация

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

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

setGlyphType(glyphType)

Устанавливает GlyphType элемента списка.

Параметры

Имя Тип Описание
glyphType GlyphType тип глифа

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

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

Авторизация

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

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

setHeading(heading)

Устанавливает заголовок ParagraphHeading .

Параметры

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

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

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

Авторизация

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

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

setIndentEnd(indentEnd)

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

Параметры

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

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

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

Авторизация

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

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

setIndentFirstLine(indentFirstLine)

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

Параметры

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

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

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

Авторизация

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

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

setIndentStart(indentStart)

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

Параметры

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

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

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

Авторизация

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

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

setLeftToRight(leftToRight)

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

Параметры

Имя Тип Описание
leftToRight Boolean установка слева направо

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

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

Авторизация

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

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

setLineSpacing(multiplier)

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

Параметры

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

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

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

Авторизация

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

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

setLinkUrl(url)

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

Параметры

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

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

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

Авторизация

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

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

setListId(listItem)

Устанавливает идентификатор списка.

Идентификатору списка присваивается то же значение, что и для указанного ListItem . Два ListItems будут рассматриваться как элементы одного и того же списка.

Параметры

Имя Тип Описание
listItem ListItem элемент списка, чей идентификатор списка использовать

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

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

Авторизация

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

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

setNestingLevel(nestingLevel)

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

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

Параметры

Имя Тип Описание
nestingLevel Integer уровень вложенности

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

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

Авторизация

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

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

setSpacingAfter(spacingAfter)

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

Параметры

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

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

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

Авторизация

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

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

setSpacingBefore(spacingBefore)

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

Параметры

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

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

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

Авторизация

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

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

setText(text)

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

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

Параметры

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

Авторизация

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

  • 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Параметры

Имя Тип Описание
textAlignment TextAlignment применяемый тип выравнивания текста

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

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

Авторизация

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

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