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

Class Footnote

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

Методы

Метод	Тип возврата	Краткое описание
`copy()`	`Footnote`	Возвращает отдельную глубокую копию текущего элемента.
`getAttributes()`	`Object`	Получает атрибуты элемента.
`getFootnoteContents()`	`FootnoteSection`	Получает содержимое элемента сноски.
`getNextSibling()`	`Element`	Извлекает следующий родственный элемент элемента.
`getParent()`	`ContainerElement`	Извлекает родительский элемент элемента.
`getPreviousSibling()`	`Element`	Извлекает предыдущий родственный элемент элемента.
`getType()`	`ElementType`	Получает `ElementType` элемента.
`isAtDocumentEnd()`	`Boolean`	Определяет, находится ли элемент в конце `Document` .
`removeFromParent()`	`Footnote`	Удаляет элемент из его родителя.
`setAttributes(attributes)`	`Footnote`	Устанавливает атрибуты элемента.

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

`copy()`

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

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

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

Footnote — Новый экземпляр.

Авторизация

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

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

`getFootnoteContents()`

Получает содержимое элемента сноски.

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

FootnoteSection — раздел сносок.

Авторизация

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

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

`getNextSibling()`

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

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

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

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

Авторизация

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

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

`getParent()`

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

Родительский элемент содержит текущий элемент.

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

ContainerElement — Родительский элемент.

Авторизация

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

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

`getPreviousSibling()`

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

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

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

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

Авторизация

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

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

`getType()`

Получает ElementType элемента.

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var firstChild = body.getChild(0);

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

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

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

Авторизация

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

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

`isAtDocumentEnd()`

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

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

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

Авторизация

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

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

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

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

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

Авторизация

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

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

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

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

Авторизация

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

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