Class HeaderSection

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Раздел заголовка

Элемент, представляющий раздел заголовка. Document обычно содержит не более одного HeaderSection . HeaderSection может содержать ListItem , Paragraph и Table . Дополнительные сведения о структуре документа см. в руководстве по расширению Документов Google .

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новое HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного большого двоичного объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет заданный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem , содержащий указанное текстовое содержимое.
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.
appendTable(table) Table Добавляет данную Table .
clear() HeaderSection Очищает содержимое элемента.
copy() HeaderSection Возвращает отдельную, глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, используя регулярные выражения.
findText(searchPattern, from) RangeElement Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
getAttributes() Object Извлекает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Извлекает дочерний индекс для указанного дочернего элемента.
getImages() InlineImage[] Извлекает все InlineImages содержащиеся в разделе.
getListItems() ListItem[] Извлекает все ListItems содержащиеся в разделе.
getNumChildren() Integer Получает количество детей.
getParagraphs() Paragraph[] Извлекает все Paragraphs , содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getTables() Table[] Извлекает все Tables , содержащиеся в разделе.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Извлекает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет данный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
removeChild(child) HeaderSection Удаляет указанный дочерний элемент.
removeFromParent() HeaderSection Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) HeaderSection Устанавливает атрибуты элемента.
setText(text) HeaderSection Устанавливает содержимое как обычный текст.
setTextAlignment(textAlignment) HeaderSection Устанавливает выравнивание текста.

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

appendHorizontalRule()

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

HorizontalRule будет содержаться в новом Paragraph .

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

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

Авторизация

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

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

appendImage(image)

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

Изображение будет содержаться в новом Paragraph .

Параметры

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

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

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

Авторизация

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

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

appendImage(image)

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

InlineImage будет содержаться в новом Paragraph .

Используйте эту версию appendImage при добавлении копии существующего InlineImage .

Параметры

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

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

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

Авторизация

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

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

appendListItem(listItem)

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

Используйте эту версию appendListItem при добавлении копии существующего ListItem .

Параметры

Имя Тип Описание
listItem ListItem элемент списка для добавления

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

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

Авторизация

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

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

appendListItem(text)

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

Последовательные элементы списка добавляются как часть одного и того же списка.

Параметры

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

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

ListItem — новый элемент списка

Авторизация

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

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

appendParagraph(paragraph)

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

Используйте эту версию appendParagraph при добавлении копии существующего Paragraph .

Параметры

Имя Тип Описание
paragraph Paragraph абзац для добавления

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

Paragraph — присоединенный абзац

Авторизация

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

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

appendParagraph(text)

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

Параметры

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

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

Paragraph — новый абзац

Авторизация

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

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

appendTable()

Создает и добавляет новую Table .

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

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

Table — новая таблица

Авторизация

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

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

appendTable(cells)

Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.

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

Параметры

Имя Тип Описание
cells String[][] текстовое содержимое ячеек таблицы для добавления в новую таблицу

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

Table — присоединенная таблица

Авторизация

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

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

appendTable(table)

Добавляет данную Table .

Используйте эту версию appendTable при добавлении копии существующей Table . Этот метод также добавит пустой абзац после таблицы, поскольку документы Google Docs не могут заканчиваться таблицей.

Параметры

Имя Тип Описание
table Table таблица для добавления

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

Table — присоединенная таблица

Авторизация

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

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

clear()

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

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

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


copy()

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

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

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

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

Авторизация

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

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

editAsText()

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

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

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

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

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

Text — текстовая версия текущего элемента.


findElement(elementType)

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

Параметры

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

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

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

Авторизация

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

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

findElement(elementType, from)

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

findText(searchPattern)

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

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

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

Параметры

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

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

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

Авторизация

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

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

findText(searchPattern, from)

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

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

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

Параметры

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

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

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

Авторизация

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

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

getAttributes()

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

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

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

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

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

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

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

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

Авторизация

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

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

getChild(childIndex)

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

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

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Параметры

Имя Тип Описание
childIndex Integer индекс дочернего элемента для извлечения

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

Element — дочерний элемент по указанному индексу

Авторизация

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

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

getChildIndex(child)

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

Параметры

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

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

Integer — дочерний индекс

Авторизация

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

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

getImages()

Извлекает все InlineImages содержащиеся в разделе.

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

InlineImage[] — изображения раздела

Авторизация

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

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

getListItems()

Извлекает все ListItems содержащиеся в разделе.

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

ListItem[] — элементы списка раздела

Авторизация

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

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

getNumChildren()

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

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

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

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

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

Авторизация

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

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

getParagraphs()

Извлекает все Paragraphs , содержащиеся в разделе (включая ListItems ).

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

Paragraph[] — абзацы раздела

Авторизация

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

  • 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

getTables()

Извлекает все Tables , содержащиеся в разделе.

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

Table[] — раздел таблиц

Авторизация

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

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

getText()

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

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

String — содержимое элемента в виде текстовой строки

Авторизация

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

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

getTextAlignment()

Получает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL , DocumentApp.TextAlignment.SUBSCRIPT и DocumentApp.TextAlignment.SUPERSCRIPT .

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

TextAlignment — тип выравнивания текста или null , если текст содержит несколько типов выравнивания текста или если выравнивание текста никогда не устанавливалось.

Авторизация

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

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

getType()

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

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

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

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

ElementType — тип элемента.

Авторизация

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

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

insertHorizontalRule(childIndex)

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

HorizontalRule будет содержаться в новом Paragraph .

Параметры

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

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

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

Авторизация

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

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

insertImage(childIndex, image)

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

Параметры

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

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

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

Авторизация

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

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

insertImage(childIndex, image)

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

Изображение будет содержаться в новом Paragraph .

Параметры

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

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

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

Авторизация

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

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

insertListItem(childIndex, listItem)

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

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки
listItem ListItem элемент списка для вставки

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

ListItem — вставленный элемент списка

Авторизация

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

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

insertListItem(childIndex, text)

Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.

Параметры

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

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

ListItem — новый элемент списка

Авторизация

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

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

insertParagraph(childIndex, paragraph)

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

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки
paragraph Paragraph абзац для вставки

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

Paragraph — вставленный абзац

Авторизация

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

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

insertParagraph(childIndex, text)

Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки
text String текстовое содержание абзаца

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

Paragraph — новый абзац

Авторизация

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

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

insertTable(childIndex)

Создает и вставляет новую Table по указанному индексу.

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки

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

Table — новая таблица

Авторизация

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

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

insertTable(childIndex, cells)

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

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки
cells String[][] текстовое содержимое ячеек таблицы для добавления в новую таблицу

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

Table — новая таблица

Авторизация

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

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

insertTable(childIndex, table)

Вставляет данную Table по указанному индексу.

Параметры

Имя Тип Описание
childIndex Integer индекс для вставки
table Table таблица для вставки

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

Table — вставленная таблица

Авторизация

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

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

removeChild(child)

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

Параметры

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

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

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

Авторизация

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

  • 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();
}

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

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

Авторизация

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

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 Атрибуты элемента.

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

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

Авторизация

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

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

setText(text)

Устанавливает содержимое как обычный текст.

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

Параметры

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

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

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

Авторизация

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

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

setTextAlignment(textAlignment)

Устанавливает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL , DocumentApp.TextAlignment.SUBSCRIPT и DocumentApp.TextAlignment.SUPERSCRIPT .

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Параметры

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

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

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

Авторизация

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

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

Устаревшие методы