Элемент, представляющий абзац. Paragraph
может содержать элементы Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
и Text
. Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .
Paragraphs
не могут содержать символы новой строки. Символы новой строки («\n») преобразуются в символы разрыва строки («\r»).
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a tab header paragraph. var header = body.appendParagraph("A Document"); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. var section = body.appendParagraph("Section 1"); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph("This is a typical paragraph.");
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addPositionedImage(image) | PositionedImage | Создает и вставляет новый PositionedImage из указанного BLOB-объекта изображения. |
appendHorizontalRule() | HorizontalRule | Создает и добавляет новый HorizontalRule . |
appendInlineImage(image) | InlineImage | Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения. |
appendInlineImage(image) | InlineImage | Добавляет заданный InlineImage . |
appendPageBreak() | PageBreak | Создает и добавляет новый PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Добавляет заданный PageBreak . |
appendText(text) | Text | Создает и добавляет новый элемент Text с указанным содержимым. |
appendText(text) | Text | Добавляет заданный элемент Text . |
clear() | Paragraph | Очищает содержимое элемента. |
copy() | Paragraph | Возвращает отдельную глубокую копию текущего элемента. |
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 | Получает дочерний индекс для указанного дочернего элемента. |
getHeading() | ParagraphHeading | Получает ParagraphHeading . |
getIndentEnd() | Number | Получает конечный отступ в пунктах. |
getIndentFirstLine() | Number | Получает отступ первой строки в пунктах. |
getIndentStart() | Number | Получает начальный отступ. |
getLineSpacing() | Number | Получает межстрочный интервал в пунктах. |
getLinkUrl() | String | Получает URL-адрес ссылки. |
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 из указанного BLOB-объекта изображения по указанному индексу. |
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() | Paragraph | Объединяет элемент с предыдущим одноуровневым элементом того же типа. |
removeChild(child) | Paragraph | Удаляет указанный дочерний элемент. |
removeFromParent() | Paragraph | Удаляет элемент из его родителя. |
removePositionedImage(id) | Boolean | Удаляет PositionedImage по идентификатору изображения. |
replaceText(searchPattern, replacement) | Element | Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения. |
setAlignment(alignment) | Paragraph | Устанавливает HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Устанавливает атрибуты элемента. |
setHeading(heading) | Paragraph | Устанавливает ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Устанавливает конечный отступ в пунктах. |
setIndentFirstLine(indentFirstLine) | Paragraph | Устанавливает отступ первой строки в пунктах. |
setIndentStart(indentStart) | Paragraph | Устанавливает начальный отступ в пунктах. |
setLeftToRight(leftToRight) | Paragraph | Устанавливает настройку слева направо. |
setLineSpacing(multiplier) | Paragraph | Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала. |
setLinkUrl(url) | Paragraph | Устанавливает URL-адрес ссылки. |
setSpacingAfter(spacingAfter) | Paragraph | Устанавливает интервал после элемента в пунктах. |
setSpacingBefore(spacingBefore) | Paragraph | Устанавливает интервал перед элементом в пунктах. |
setText(text) | void | Устанавливает содержимое абзаца как текст. |
setTextAlignment(textAlignment) | Paragraph | Устанавливает выравнивание текста. |
Подробная документация
addPositionedImage(image)
Создает и вставляет новый PositionedImage
из указанного BLOB-объекта изображения.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the specified image URL. const image = UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png'); // Adds the image to the tab, anchored to the first paragraph. paragraph.addPositionedImage(image);
Параметры
Имя | Тип | Описание |
---|---|---|
image | BlobSource | Данные изображения. |
Возвращаться
PositionedImage
— Новое позиционированное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendHorizontalRule()
Создает и добавляет новый HorizontalRule
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
Возвращаться
HorizontalRule
— Новое горизонтальное правило.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Создает и добавляет новый InlineImage
из указанного BLOB-объекта изображения.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the image from the specified image URL. const image = UrlFetchApp .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png'); // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Параметры
Имя | Тип | Описание |
---|---|---|
image | BlobSource | Данные изображения. |
Возвращаться
InlineImage
— добавленное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Добавляет заданный InlineImage
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Makes a copy of the first image in the body. const image = body.getImages()[0].copy();; // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Параметры
Имя | Тип | Описание |
---|---|---|
image | InlineImage | Данные изображения. |
Возвращаться
InlineImage
— добавленное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
Создает и добавляет новый PageBreak
.
Примечание. PageBreaks
не может содержаться в TableCells
. Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. paragraph.appendPageBreak();
Возвращаться
PageBreak
— новый элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Добавляет заданный PageBreak
.
Примечание. PageBreaks
не может содержаться в TableCells
. Если текущий элемент существует в ячейке таблицы, скрипт выдает исключение.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. const pageBreak = paragraph.appendPageBreak(); // Makes a copy of the page break. const newPageBreak = pageBreak.copy(); // Adds the copied page break to the paragraph. paragraph.appendPageBreak(newPageBreak);
Параметры
Имя | Тип | Описание |
---|---|---|
pageBreak | PageBreak | Разрыв страницы для добавления. |
Возвращаться
PageBreak
— добавленный элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Создает и добавляет новый элемент Text
с указанным содержимым.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a string to the paragraph. paragraph.appendText('This is a new sentence.');
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текстовое содержание. |
Возвращаться
Text
— новый текстовый элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Добавляет заданный элемент Text
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the text from the first paragraph in the body. const paragraph1 = body.getParagraphs()[0]; const text = paragraph1.getText(); // Gets the third paragraph in the body. const paragraph3 = body.getParagraphs()[2]; // Adds the text from the first paragraph to the third paragraph. paragraph3.appendText(text);
Параметры
Имя | Тип | Описание |
---|---|---|
text | Text | Текстовый элемент для добавления. |
Возвращаться
Text
— добавленный текстовый элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Возвращает отдельную глубокую копию текущего элемента.
Любые дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родителя.
Возвращаться
Paragraph
— Новая копия.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Получает Text
версию текущего элемента для редактирования.
Используйте editAsText
для управления содержимым элементов в виде форматированного текста. Режим editAsText
игнорирует нетекстовые элементы (такие как InlineImage
и HorizontalRule
).
Дочерние элементы, полностью содержащиеся в удаленном текстовом диапазоне, удаляются из элемента.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Возвращаться
Text
— текстовая версия текущего элемента.
findElement(elementType)
Ищет в содержимом элемента потомка указанного типа.
Параметры
Имя | Тип | Описание |
---|---|---|
elementType | ElementType | Тип элемента для поиска. |
Возвращаться
RangeElement
— Результат поиска, указывающий позицию искомого элемента.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Sets the horizontal alignment to left for the first paragraph. paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT); // Gets the horizontal alignment of the first paragraph and logs it to the console. console.log(paragraph.getAlignment().toString());
Возвращаться
HorizontalAlignment
— Выравнивание.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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
getChild(childIndex)
Извлекает дочерний элемент по указанному дочернему индексу.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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
getHeading()
Получает ParagraphHeading
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Adds a paragraph to the body. const paragraph = body.appendParagraph('Title heading'); // Sets the paragraph heading style to 'Title.' paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE); // Gets the heading style and logs it to the console. console.log(paragraph.getHeading().toString());
Возвращаться
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
getNextSibling()
Извлекает следующий родственный элемент элемента.
Следующий брат имеет того же родителя и следует за текущим элементом.
Возвращаться
Element
— следующий родственный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Получает количество детей.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log("There are " + body.getNumChildren() + " elements in the tab's body.");
Возвращаться
Integer
— количество детей.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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 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
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 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();
Возвращаться
Paragraph
— объединенный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Удаляет указанный дочерний элемент.
Параметры
Имя | Тип | Описание |
---|---|---|
child | Element | дочерний элемент для удаления |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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(); }
Возвращаться
Paragraph
— удаленный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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().getActiveTab().asDocumentTab().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 | горизонтальное выравнивание |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 | Атрибуты элемента. |
Возвращаться
Paragraph
— текущий элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeading(heading)
Устанавливает ParagraphHeading
.
Параметры
Имя | Тип | Описание |
---|---|---|
heading | ParagraphHeading | заголовок |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Устанавливает конечный отступ в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indentEnd | Number | конечный отступ, в пунктах |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
Устанавливает отступ первой строки в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indentFirstLine | Number | отступ первой строки, в пунктах |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Устанавливает начальный отступ в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indentStart | Number | начальный отступ, в пунктах |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Устанавливает настройку слева направо.
Параметры
Имя | Тип | Описание |
---|---|---|
leftToRight | Boolean | настройка слева направо |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала.
Параметры
Имя | Тип | Описание |
---|---|---|
multiplier | Number | количество строк |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Устанавливает URL-адрес ссылки.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес ссылки |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Устанавливает интервал после элемента в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
spacingAfter | Number | расстояние после элемента, в пунктах |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Устанавливает интервал перед элементом в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
spacingBefore | Number | расстояние перед элементом, в пунктах |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Параметры
Имя | Тип | Описание |
---|---|---|
textAlignment | TextAlignment | тип выравнивания текста, который нужно применить |
Возвращаться
Paragraph
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents