Class FootnoteSection

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
Sección del pie de página

Un elemento que representa una sección de nota al pie. Un FootnoteSection contiene el texto que corresponde a un Footnote. El FootnoteSection puede contener elementos ListItem o Paragraph. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendParagraph(paragraph)ParagraphAgrega el Paragraph especificado.
appendParagraph(text)ParagraphCrea y agrega un Paragraph nuevo con el contenido de texto especificado.
clear()FootnoteSectionBorra el contenido del elemento.
copy()FootnoteSectionMuestra una copia independiente y profunda del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElementBusca el contenido del elemento para un descendiente del tipo especificado.
findElement(elementType, from)RangeElementBusca el contenido del elemento para un descendiente del tipo especificado, a partir del RangeElement especificado.
findText(searchPattern)RangeElementBusca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.
findText(searchPattern, from)RangeElementBusca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario para el elemento secundario especificado.
getNextSibling()ElementRecupera el siguiente elemento del mismo nivel del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]Recupera todos los Paragraphs contenidos en la sección (incluido ListItems).
getParent()ContainerElementRecupera el elemento principal del elemento.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior del elemento.
getText()StringRecupera el contenido del elemento como una string de texto.
getTextAlignment()TextAlignmentObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph determinado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que incluye el contenido de texto especificado.
removeChild(child)FootnoteSectionQuita el elemento secundario especificado.
removeFromParent()FootnoteSectionQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todas las ocurrencias de un patrón de texto dado con una string de reemplazo determinada, mediante expresiones regulares.
setAttributes(attributes)FootnoteSectionEstablece los atributos del elemento.
setText(text)FootnoteSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)FootnoteSectionEstablece la alineación del texto.

Documentación detallada

appendParagraph(paragraph)

Agrega el Paragraph especificado.

Usa esta versión de appendParagraph cuando agregues una copia de un Paragraph existente.

Parámetros

NombreTipoDescripción
paragraphParagraphel párrafo para adjuntar

Volver

Paragraph: es el párrafo adjunto.

Autorización

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

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

appendParagraph(text)

Crea y agrega un Paragraph nuevo con el contenido de texto especificado.

Parámetros

NombreTipoDescripción
textStringel contenido del texto del párrafo

Volver

Paragraph: el párrafo nuevo

Autorización

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

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

clear()

Borra el contenido del elemento.

Volver

FootnoteSection: el elemento actual


copy()

Muestra una copia independiente y profunda del elemento actual.

También se copiarán todos los elementos secundarios que contenga. El nuevo elemento no tiene un elemento principal.

Volver

FootnoteSection: 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 alcances:

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

editAsText()

Obtiene una versión Text del elemento actual para editarla.

Usa editAsText para manipular el contenido de los elementos como texto enriquecido. El modo editAsText ignora los elementos que no son de texto (como InlineImage y HorizontalRule).

Los elementos secundarios que se encuentran dentro de un rango de texto eliminado se quitan del elemento.

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

Volver

Text: Es una versión de texto del elemento actual.


findElement(elementType)

Busca el contenido del elemento para un descendiente del tipo especificado.

Parámetros

NombreTipoDescripción
elementTypeElementTypeel tipo de elemento que se buscará

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del elemento de búsqueda.

Autorización

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

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

findElement(elementType, from)

Busca el contenido del elemento para un descendiente del tipo especificado, a partir del RangeElement especificado.

// 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;
  }
}

Parámetros

NombreTipoDescripción
elementTypeElementTypeel tipo de elemento que se buscará
fromRangeElementel resultado de la búsqueda

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del elemento de la búsqueda.

Autorización

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

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

findText(searchPattern)

Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón que se buscará

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de la búsqueda, o bien un valor nulo si no coincide.

Autorización

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

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

findText(searchPattern, from)

Busca el contenido del elemento para el patrón de texto especificado a partir de un resultado de búsqueda determinado.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón que se buscará
fromRangeElementel resultado de la búsqueda

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del texto de la búsqueda, o bien un valor nulo si no coincide.

Autorización

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

  • 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 en la enumeración 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]);
}

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 alcances:

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

getChild(childIndex)

Recupera el elemento secundario en el índice secundario especificado.

// 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.");
}

Parámetros

NombreTipoDescripción
childIndexIntegerel índice del elemento secundario que se debe recuperar

Volver

Element: el elemento secundario en el índice especificado

Autorización

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

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

getChildIndex(child)

Recupera el índice secundario para el elemento secundario especificado.

Parámetros

NombreTipoDescripción
childElementel elemento secundario para el que se recupera el índice

Volver

Integer: Es el índice secundario.

Autorización

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

  • 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 principal y sigue el elemento actual.

Volver

Element: 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 alcances:

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

getNumChildren()

Recupera la cantidad de elementos secundarios.

// 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.");

Volver

Integer: la cantidad de niños

Autorización

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

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

getParagraphs()

Recupera todos los Paragraphs contenidos en la sección (incluido ListItems).

Volver

Paragraph[]: los párrafos de la sección

Autorización

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

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

getParent()

Recupera el elemento principal del elemento.

El elemento principal contiene el elemento actual.

Volver

ContainerElement: Es el elemento principal.

Autorización

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

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

getPreviousSibling()

Recupera el elemento del mismo nivel anterior del elemento.

El elemento anterior tiene el mismo elemento principal y precede al elemento actual.

Volver

Element: el elemento del mismo nivel anterior.

Autorización

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

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

getText()

Recupera el contenido del elemento como una string de texto.

Volver

String: El contenido del elemento como string de texto

Autorización

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

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

getTextAlignment()

Obtiene la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

Volver

TextAlignment: Es el tipo de alineación de texto, o null si el texto contiene varios tipos de alineaciones de texto o si nunca se configuró la alineación.

Autorización

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

  • 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.

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

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 alcances:

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

insertParagraph(childIndex, paragraph)

Inserta el Paragraph determinado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará
paragraphParagraphel párrafo para insertar

Volver

Paragraph: es el párrafo insertado.

Autorización

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

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

insertParagraph(childIndex, text)

Crea e inserta un nuevo Paragraph en el índice especificado, que incluye el contenido de texto especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará
textStringel contenido del texto del párrafo

Volver

Paragraph: el párrafo nuevo

Autorización

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

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

removeChild(child)

Quita el elemento secundario especificado.

Parámetros

NombreTipoDescripción
childElementel elemento secundario que se desea quitar

Volver

FootnoteSection: 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 alcances:

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

removeFromParent()

Quita el elemento de su elemento superior.

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

Volver

FootnoteSection: el elemento que se quitó.

Autorización

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

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

replaceText(searchPattern, replacement)

Reemplaza todas las ocurrencias de un patrón de texto dado con una string de reemplazo determinada, mediante expresiones regulares.

El patrón de búsqueda se pasa como una string, no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra invertida en el patrón.

Este método usa la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis compatible.

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

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

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

Parámetros

NombreTipoDescripción
searchPatternStringel patrón de regex que se buscará
replacementStringel texto que se usará como reemplazo

Volver

Element: 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 alcances:

  • 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 en la enumeración DocumentApp.Attribute y cada valor de propiedad sea el valor nuevo que se aplicará.

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

Parámetros

NombreTipoDescripción
attributesObjectLos atributos del elemento.

Volver

FootnoteSection: 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 alcances:

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

setText(text)

Establece el contenido como texto sin formato.

Nota: Se elimina el contenido existente.

Parámetros

NombreTipoDescripción
textStringel nuevo contenido de texto

Volver

FootnoteSection: 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 alcances:

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

setTextAlignment(textAlignment)

Establece la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

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

Parámetros

NombreTipoDescripción
textAlignmentTextAlignmentel tipo de alineación del texto que se aplicará

Volver

FootnoteSection: 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 alcances:

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

Métodos obsoletos