Элемент, представляющий область, которая неизвестна или не может быть затронута сценарием, например номер страницы.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy() | UnsupportedElement | Возвращает отдельную, глубокую копию текущего элемента. |
getAttributes() | Object | Извлекает атрибуты элемента. |
getNextSibling() | Element | Извлекает следующий одноуровневый элемент элемента. |
getParent() | ContainerElement | Извлекает родительский элемент элемента. |
getPreviousSibling() | Element | Извлекает предыдущий родственный элемент элемента. |
getType() | ElementType | Извлекает ElementType элемента. |
isAtDocumentEnd() | Boolean | Определяет, находится ли элемент в конце Document . |
merge() | UnsupportedElement | Объединяет элемент с предыдущим элементом того же типа. |
removeFromParent() | UnsupportedElement | Удаляет элемент из его родителя. |
setAttributes(attributes) | UnsupportedElement | Задает атрибуты элемента. |
Подробная документация
copy()
Возвращает отдельную, глубокую копию текущего элемента.
Любые дочерние элементы, присутствующие в элементе, также копируются. Новый элемент не имеет родителя.
Возвращаться
UnsupportedElement
— Новая копия.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
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
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 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
isAtDocumentEnd()
Определяет, находится ли элемент в конце Document
.
Возвращаться
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();
Возвращаться
UnsupportedElement
— Объединенный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
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(); }
Возвращаться
UnsupportedElement
— Удаленный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
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 | Атрибуты элемента. |
Возвращаться
UnsupportedElement
— Текущий элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents