Class Footnote

Footnote

Un elemento que representa una nota al pie. Cada Footnote se encuentra dentro de un ListItem o Paragraph y tiene un elemento FootnoteSection correspondiente para el contenido de la nota al pie. El elemento Footnote no puede contener ningún otro elemento. Para obtener más información sobre la estructura del documento, consulta la guía para extender Google Docs.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
copy()	Footnote	Devuelve una copia profunda y separada del elemento actual.
getAttributes()	Object	Recupera los atributos del elemento.
getFootnoteContents()	FootnoteSection|null	Recupera el contenido del elemento de nota al pie.
getNextSibling()	Element|null	Recupera el siguiente elemento del mismo nivel del elemento.
getParent()	ContainerElement|null	Recupera el elemento superior del elemento.
getPreviousSibling()	Element|null	Recupera el elemento anterior del mismo nivel del elemento.
getType()	ElementType	Recupera el ElementType del elemento.
isAtDocumentEnd()	Boolean	Determina si el elemento está al final del Document.
removeFromParent()	Footnote|null	Quita el elemento de su elemento superior.
setAttributes(attributes)	Footnote	Establece los atributos del elemento.

Documentación detallada

copy()

Devuelve una copia profunda y separada del elemento actual.

También se copian los elementos secundarios presentes en el elemento. El elemento nuevo no tiene un elemento superior.

Volver

Footnote: La copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getAttributes()

Recupera los atributos del elemento.

El resultado es un objeto que contiene una propiedad para cada atributo de elemento válido, en el que cada nombre de propiedad corresponde a un elemento de la enumeración DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Volver

Object: Los atributos del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getFootnoteContents()

Recupera el contenido del elemento de nota al pie.

Volver

FootnoteSection|null — La sección de nota al pie

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getNextSibling()

Recupera el siguiente elemento del mismo nivel del elemento.

El siguiente elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.

Volver

Element|null: El siguiente elemento del mismo nivel.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getParent()

Recupera el elemento superior del elemento.

El elemento superior contiene el elemento actual.

Volver

ContainerElement|null — El elemento superior.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getPreviousSibling()

Recupera el elemento anterior del mismo nivel del elemento.

El elemento anterior del mismo nivel tiene el mismo elemento superior y precede al elemento actual.

Volver

Element|null: El elemento anterior del mismo nivel.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

getType()

Recupera el ElementType del elemento.

Usa getType() para determinar el tipo exacto de un elemento determinado.

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

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

const 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.');
}

Volver

ElementType: El tipo de elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

isAtDocumentEnd()

Determina si el elemento está al final del Document.

Volver

Boolean: Indica si el elemento está al final de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

removeFromParent()

Quita el elemento de su elemento superior.

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Volver

Footnote|null: El elemento quitado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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

---

setAttributes(attributes)

Establece los atributos del elemento.

El parámetro de atributos especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración DocumentApp.Attribute y cada valor de propiedad sea el valor nuevo que se aplicará.

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

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parámetros

Nombre	Tipo	Descripción
attributes	Object	Los atributos del elemento.

Volver

Footnote: El elemento actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes permisos:

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