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


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

Параметры

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

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

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

Авторизация

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

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