Interface Element

Элемент

Общий элемент. Содержимое Document представлено в виде элементов. Например, ListItem , Paragraph и Table являются элементами и наследуют все методы, определенные Element , такие как getType() .

Реализация классов

Имя Краткое описание
Body Содержимое вкладки в документе Google Docs.
ContainerElement Общий элемент, который может содержать другие элементы.
Date Элемент, представляющий форматированную дату
Equation Элемент, представляющий математическое выражение.
EquationFunction Элемент, представляющий функцию в математическом Equation .
EquationFunctionArgumentSeparator Элемент, представляющий разделитель функций в математическом Equation .
EquationSymbol Элемент, представляющий символ в математическом Equation .
FooterSection Элемент, представляющий раздел нижнего колонтитула.
Footnote Элемент, представляющий сноску.
FootnoteSection Элемент, представляющий раздел сноски.
HeaderSection Элемент, представляющий раздел заголовка.
HorizontalRule Элемент, представляющий горизонтальную линейку.
InlineDrawing Элемент, представляющий встроенный рисунок.
InlineImage Элемент, представляющий внедренное изображение.
ListItem Элемент, представляющий элемент списка.
PageBreak Элемент, представляющий разрыв страницы.
Paragraph Элемент, представляющий абзац.
Person Элемент, представляющий ссылку на человека.
RichLink Элемент, представляющий ссылку на ресурс Google, например файл на Диске или видео YouTube.
Table Элемент, представляющий таблицу.
TableCell Элемент, представляющий ячейку таблицы.
TableOfContents Элемент, содержащий оглавление.
TableRow Элемент, представляющий строку таблицы.
Text Элемент, представляющий область форматированного текста.
UnsupportedElement Элемент, представляющий регион, который неизвестен или не может быть затронут сценарием, например номер страницы.

Методы

Метод Тип возврата Краткое описание
asBody() Body Возвращает текущий элемент как Body .
asDate() Date Возвращает текущий элемент как Date .
asEquation() Equation Возвращает текущий элемент как Equation .
asEquationFunction() EquationFunction Возвращает текущий элемент как EquationFunction .
asEquationFunctionArgumentSeparator() EquationFunctionArgumentSeparator Возвращает текущий элемент как EquationFunctionArgumentSeparator .
asEquationSymbol() EquationSymbol Возвращает текущий элемент как EquationSymbol .
asFooterSection() FooterSection Возвращает текущий элемент как FooterSection .
asFootnote() Footnote Возвращает текущий элемент как Footnote .
asFootnoteSection() FootnoteSection Возвращает текущий элемент как FootnoteSection .
asHeaderSection() HeaderSection Возвращает текущий элемент как HeaderSection .
asHorizontalRule() HorizontalRule Возвращает текущий элемент как HorizontalRule .
asInlineDrawing() InlineDrawing Возвращает текущий элемент как InlineDrawing .
asInlineImage() InlineImage Возвращает текущий элемент как InlineImage .
asListItem() ListItem Возвращает текущий элемент как ListItem .
asPageBreak() PageBreak Возвращает текущий элемент как PageBreak .
asParagraph() Paragraph Возвращает текущий элемент как Paragraph .
asPerson() Person Возвращает текущий элемент как Person .
asRichLink() RichLink Возвращает текущий элемент как RichLink , например ссылку на файл Google Sheets.
asTable() Table Возвращает текущий элемент в виде Table .
asTableCell() TableCell Возвращает текущий элемент как TableCell .
asTableOfContents() TableOfContents Возвращает текущий элемент как TableOfContents .
asTableRow() TableRow Возвращает текущий элемент как TableRow .
asText() Text Возвращает текущий элемент как Text .
copy() Element Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Element Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Element Удаляет элемент из его родителя.
setAttributes(attributes) Element Устанавливает атрибуты элемента.

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

asBody()

Возвращает текущий элемент как Body .

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

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

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

Авторизация

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

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

asDate()

Возвращает текущий элемент как Date .

Если вы знаете, что элемент является Date , используйте этот метод, чтобы установить его тип Date . Это позволит автозаполнению в редакторе Apps Script показать методы, которые можно использовать с Date .

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

Date — Текущий элемент с типом Date .

Авторизация

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

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

asEquation()

Возвращает текущий элемент как Equation .

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

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

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

Авторизация

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

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

asEquationFunction()

Возвращает текущий элемент как EquationFunction .

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

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

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

Авторизация

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

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

asEquationFunctionArgumentSeparator()

Возвращает текущий элемент как EquationFunctionArgumentSeparator .

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

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

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

Авторизация

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

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

asEquationSymbol()

Возвращает текущий элемент как EquationSymbol .

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

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

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

Авторизация

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

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

asFooterSection()

Возвращает текущий элемент как FooterSection .

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

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

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

Авторизация

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

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

asFootnote()

Возвращает текущий элемент как Footnote .

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

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

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

Авторизация

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

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

asFootnoteSection()

Возвращает текущий элемент как FootnoteSection .

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

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

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

Авторизация

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

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

asHeaderSection()

Возвращает текущий элемент как HeaderSection .

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

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

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

Авторизация

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

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

asHorizontalRule()

Возвращает текущий элемент как HorizontalRule .

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

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

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

Авторизация

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

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

asInlineDrawing()

Возвращает текущий элемент как InlineDrawing .

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

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

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

Авторизация

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

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

asInlineImage()

Возвращает текущий элемент как InlineImage .

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

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

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

Авторизация

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

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

asListItem()

Возвращает текущий элемент как ListItem .

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

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

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

Авторизация

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

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

asPageBreak()

Возвращает текущий элемент как PageBreak .

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

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

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

Авторизация

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

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

asParagraph()

Возвращает текущий элемент как Paragraph .

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

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

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

Авторизация

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

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

asPerson()

Возвращает текущий элемент как Person .

Если вы знаете, что элемент является Person , используйте этот метод, чтобы установить его тип как Person. Это позволит автозаполнению в редакторе Apps Script показать методы, которые можно использовать с элементом person.

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

Person — Текущий элемент с типом, установленным как Person .

Авторизация

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

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

Возвращает текущий элемент как RichLink , например ссылку на файл Google Sheets.

Если вы знаете, что элемент является RichLink , используйте этот метод, чтобы установить его тип RichLink . Это позволит автозаполнению в редакторе Apps Script показать вам методы, которые можно использовать с RichLink .

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

RichLink — Текущий элемент с типом RichLink .

Авторизация

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

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

asTable()

Возвращает текущий элемент в виде Table .

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

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

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

Авторизация

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

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

asTableCell()

Возвращает текущий элемент как TableCell .

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

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

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

Авторизация

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

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

asTableOfContents()

Возвращает текущий элемент как TableOfContents .

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

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

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

Авторизация

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

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

asTableRow()

Возвращает текущий элемент как TableRow .

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

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

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

Авторизация

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

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

asText()

Возвращает текущий элемент как Text .

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

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

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

Авторизация

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

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

copy()

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

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

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

Element — Новая копия.

Авторизация

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

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

getAttributes()

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

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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

getNextSibling()

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

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

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

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

Авторизация

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

  • 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

getPreviousSibling()

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

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

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

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

Авторизация

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

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

getType()

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

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

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

// Obtain the first element in the active tab's 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

isAtDocumentEnd()

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

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

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

Авторизация

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

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

merge()

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

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

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

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

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

Авторизация

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

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

removeFromParent()

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

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

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

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

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

Авторизация

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

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

setAttributes(attributes)

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

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 Атрибуты элемента.

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

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

Авторизация

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

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