Эта страница переведена с помощью Cloud Translation API.

Class FootnoteSection

Элемент, представляющий раздел сноски. FootnoteSection содержит текст, соответствующий Footnote . FootnoteSection может содержать элементы ListItem или Paragraph . Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .

Методы

Метод	Тип возврата	Краткое описание
`appendParagraph(paragraph)`	`Paragraph`	Добавляет данный `Paragraph` .
`appendParagraph(text)`	`Paragraph`	Создает и добавляет новый `Paragraph` , содержащий указанное текстовое содержимое.
`clear()`	`FootnoteSection`	Очищает содержимое элемента.
`copy()`	`FootnoteSection`	Возвращает отдельную глубокую копию текущего элемента.
`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`	Получает дочерний индекс для указанного дочернего элемента.
`getNextSibling()`	`Element`	Извлекает следующий родственный элемент элемента.
`getNumChildren()`	`Integer`	Получает количество детей.
`getParagraphs()`	`Paragraph[]`	Извлекает все `Paragraphs` , содержащиеся в разделе (включая `ListItems` ).
`getParent()`	`ContainerElement`	Извлекает родительский элемент элемента.
`getPreviousSibling()`	`Element`	Извлекает предыдущий родственный элемент элемента.
`getText()`	`String`	Извлекает содержимое элемента в виде текстовой строки.
`getTextAlignment()`	`TextAlignment`	Получает выравнивание текста.
`getType()`	`ElementType`	Получает `ElementType` элемента.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Вставляет данный `Paragraph` по указанному индексу.
`insertParagraph(childIndex, text)`	`Paragraph`	Создает и вставляет новый `Paragraph` по указанному индексу, содержащий указанное текстовое содержимое.
`removeChild(child)`	`FootnoteSection`	Удаляет указанный дочерний элемент.
`removeFromParent()`	`FootnoteSection`	Удаляет элемент из его родителя.
`replaceText(searchPattern, replacement)`	`Element`	Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
`setAttributes(attributes)`	`FootnoteSection`	Устанавливает атрибуты элемента.
`setText(text)`	`FootnoteSection`	Устанавливает содержимое в виде обычного текста.
`setTextAlignment(textAlignment)`	`FootnoteSection`	Устанавливает выравнивание текста.

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

Метод	Тип возврата	Краткое описание
`getFootnotes()`	`Footnote[]`	Извлекает все `Footnotes` , содержащиеся в разделе.
`getLinkUrl()`	`String`	Получает URL-адрес ссылки.
`isAtDocumentEnd()`	`Boolean`	Определяет, находится ли элемент в конце `Document` .
`setLinkUrl(url)`	`FootnoteSection`	Устанавливает URL-адрес ссылки.

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

`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

`clear()`

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

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

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

`copy()`

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

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

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

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

Авторизация

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

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

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

Параметры

Имя	Тип	Описание
`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

`getNextSibling()`

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

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

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

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

Авторизация

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

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

`getPreviousSibling()`

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

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

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

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

Авторизация

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

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

`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

`removeChild(child)`

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

Параметры

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

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

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

Авторизация

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

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

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

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

Авторизация

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

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

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

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

Авторизация

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

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

`setText(text)`

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

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

Параметры

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

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

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

Авторизация

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

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`	тип выравнивания текста, который нужно применить

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

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

Авторизация

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

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

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

`getFootnotes()`

Устарело. Этот элемент не может содержать Footnote .

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

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

Footnote[] — сноски раздела

Авторизация

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

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

`isAtDocumentEnd()`

Устарело. Этот метод ненадежен для HeaderSection .

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

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

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

Авторизация

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

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

`setLinkUrl(url)`

Устарело. Вместо применения ссылки ко всему разделу примените ссылку к элементу внутри раздела.

Устанавливает URL-адрес ссылки.

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес ссылки

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

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

Авторизация

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

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