Class FooterSection

FooterSection

Elemento que representa una sección de pie de página. Un Document suele contener como máximo un FooterSection. El FooterSection puede contener ListItem, Paragraph y Table. Si quieres obtener más información sobre la estructura de los documentos, consulta la guía para ampliar Documentos de Google.

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un HorizontalRule nuevo.
appendImage(image)InlineImageCrea y agrega un InlineImage nuevo desde el BLOB de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage especificado.
appendListItem(listItem)ListItemAgrega el ListItem especificado.
appendListItem(text)ListItemCrea y agrega un ListItem nuevo con el contenido de texto especificado.
appendParagraph(paragraph)ParagraphAgrega el Paragraph especificado.
appendParagraph(text)ParagraphCrea y agrega un Paragraph nuevo con el contenido de texto especificado.
appendTable()TableCrea y agrega un Table nuevo.
appendTable(cells)TableAgrega un Table nuevo que contiene una TableCell para cada valor de cadena especificado.
appendTable(table)TableAgrega el Table especificado.
clear()FooterSectionBorra el contenido del elemento.
copy()FooterSectionMuestra una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para su edición.
findElement(elementType)RangeElementBusca en el contenido del elemento un elemento subordinado del tipo especificado.
findElement(elementType, from)RangeElementBusca en el contenido del elemento un elemento subordinado del tipo especificado, comenzando por el especificado RangeElement.
findText(searchPattern)RangeElementBusca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.
findText(searchPattern, from)RangeElementBusca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario del índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getImages()InlineImage[]Recupera todos los InlineImages contenidos en la sección.
getListItems()ListItem[]Recupera todos los ListItems contenidos en la sección.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]Recupera todos los Paragraphs contenidos en la sección (incluido ListItems).
getParent()ContainerElementRecupera el elemento superior del elemento.
getTables()Table[]Recupera todos los Tables contenidos en la sección.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignmentObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un HorizontalRule nuevo en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage del BLOB de imagen especificado, en el lugar especificado. índice.
insertImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem proporcionado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea e inserta un ListItem nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un Paragraph nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.
insertTable(childIndex)TableCrea e inserta un Table nuevo en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contenga las celdas especificadas, en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
removeChild(child)FooterSectionQuita el elemento secundario especificado.
removeFromParent()FooterSectionQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.
setAttributes(attributes)FooterSectionEstablece los atributos del elemento.
setText(text)FooterSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)FooterSectionEstablece la alineación del texto.

Documentación detallada

appendHorizontalRule()

Crea y agrega un HorizontalRule nuevo.

El HorizontalRule estará incluido en un nuevo Paragraph.

Volver

HorizontalRule: Es la nueva regla horizontal.

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

appendImage(image)

Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado.

La imagen se incluirá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
imageBlobSourceLos datos de la imagen

Volver

InlineImage: Es la imagen anexada.

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

appendImage(image)

Agrega el InlineImage especificado.

El InlineImage estará incluido en un nuevo Paragraph.

Usa esta versión de appendImage cuando agregues una copia de un InlineImage existente.

Parámetros

NombreTipoDescripción
imageInlineImageLos datos de la imagen

Volver

InlineImage: Es la imagen anexada.

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

appendListItem(listItem)

Agrega el ListItem especificado.

Usa esta versión de appendListItem cuando agregues una copia de un ListItem existente.

Parámetros

NombreTipoDescripción
listItemListItemEl elemento de lista que se agregará.

Volver

ListItem: Es el elemento de lista agregado.

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

appendListItem(text)

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

Los elementos consecutivos se agregan como parte de la misma lista.

Parámetros

NombreTipoDescripción
textStringEl contenido de texto del elemento de lista.

Volver

ListItem: Es el elemento de lista 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

appendParagraph(paragraph)

Agrega el Paragraph especificado.

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

Parámetros

NombreTipoDescripción
paragraphParagraphEs el párrafo que se agregará.

Volver

Paragraph: Es el párrafo agregado.

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

appendTable()

Crea y agrega un Table nuevo.

Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no puede terminar con una tabla.

Volver

Table: Es la tabla 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

appendTable(cells)

Agrega un Table nuevo que contiene una TableCell para cada valor de cadena especificado.

Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no puede terminar con una tabla.

Parámetros

NombreTipoDescripción
cellsString[][]El contenido de texto de las celdas de la tabla que se agregarán a la tabla nueva.

Volver

Table: Es la tabla anexada.

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

appendTable(table)

Agrega el Table especificado.

Usa esta versión de appendTable cuando agregues una copia de un Table existente. Este método también agregará un párrafo vacío después de la tabla, ya que los documentos de Documentos de Google no puede terminar con una tabla.

Parámetros

NombreTipoDescripción
tableTableLa tabla que se va a adjuntar.

Volver

Table: Es la tabla anexada.

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

FooterSection: Es el elemento actual.

copy()

Muestra 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 superior.

Volver

FooterSection: Es 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 su edición.

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 estén completamente contenidos dentro de un rango de texto borrado se quitarán de este. 

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 en texto del elemento actual.

findElement(elementType)

Busca en el contenido del elemento un elemento subordinado 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 en el contenido del elemento un elemento subordinado del tipo especificado, comenzando por el especificado RangeElement. 

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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á.
fromRangeElementEs el resultado de la búsqueda.

Volver

RangeElement: Es un resultado de la búsqueda que indica la siguiente 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

findText(searchPattern)

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

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

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón a buscar

Volver

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

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 patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.

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

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón a buscar
fromRangeElementel resultado de la búsqueda para buscar

Volver

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

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 el nombre de la propiedad corresponde a un elemento de la enumeración 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]);
}

Volver

Object: Son 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 del índice secundario especificado. 

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

// Obtain the first element in the tab.
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 recuperará.

Volver

Element: Es 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 del 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

getImages()

Recupera todos los InlineImages contenidos en la sección.

Volver

InlineImage[]: Son las imágenes 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

getListItems()

Recupera todos los ListItems contenidos en la sección.

Volver

ListItem[]: Son los elementos de lista 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

getNumChildren()

Recupera la cantidad de elementos secundarios. 

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

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

Volver

Integer: Es la cantidad de elementos secundarios.

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[]: Son 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 superior del elemento.

El elemento superior contiene el elemento actual.

Volver

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

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

getTables()

Recupera todos los Tables contenidos en la sección.

Volver

Table[]: Son las tablas de secciones.

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 cadena de texto.

Volver

String: Es el contenido del elemento como una cadena 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 del texto, o null si el texto contiene varios tipos de texto. alineaciones o si nunca se estableció la alineación del 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

getType()

Recupera el ElementType del elemento.

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

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

Volver

ElementType: Es 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

insertHorizontalRule(childIndex)

Crea e inserta un HorizontalRule nuevo en el índice especificado.

El HorizontalRule estará incluido en un nuevo Paragraph.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se inserta el elemento.

Volver

HorizontalRule: Es la nueva regla horizontal.

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

insertImage(childIndex, image)

Crea e inserta un InlineImage del BLOB de imagen especificado, en el lugar especificado. índice.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se inserta el elemento.
imageBlobSourceLos datos de la imagen

Volver

InlineImage: Es la imagen intercalada que se insertó.

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

insertImage(childIndex, image)

Inserta el InlineImage proporcionado en el índice especificado.

La imagen se incluirá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se inserta el elemento.
imageInlineImageLa imagen que se insertará.

Volver

InlineImage: Es la imagen intercalada que se insertó.

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

insertListItem(childIndex, listItem)

Inserta el ListItem proporcionado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
listItemListItemEl elemento de lista que se insertará.

Volver

ListItem: Es el elemento de lista que se insertó.

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

insertListItem(childIndex, text)

Crea e inserta un ListItem nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
textStringEl contenido de texto del elemento de lista.

Volver

ListItem: Es el elemento de lista 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

insertParagraph(childIndex, paragraph)

Inserta el Paragraph proporcionado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
paragraphParagraphEs el párrafo que se 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 Paragraph nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
textStringEl contenido del texto del párrafo.

Volver

Paragraph: Es 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

insertTable(childIndex)

Crea e inserta un Table nuevo en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.

Volver

Table: Es la tabla 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

insertTable(childIndex, cells)

Crea e inserta un nuevo Table que contenga las celdas especificadas, en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
cellsString[][]El contenido de texto de las celdas de la tabla que se agregarán a la tabla nueva.

Volver

Table: Es la tabla 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

insertTable(childIndex, table)

Inserta el Table proporcionado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerEl índice en el que se realizará la inserción.
tableTableLa tabla que se insertará.

Volver

Table: Es la tabla que se insertó.

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 quitará.

Volver

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

Volver

FooterSection: Es 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 todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.

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

Este método usa el estándar RE2 de Google expresión de comandos, que limita la sintaxis compatible.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual. 

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 para buscar
replacementStringel texto que se usará como reemplazo

Volver

Element: Es 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 especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento la enumeración DocumentApp.Attribute y el valor de cada propiedad es el nuevo que se debe se aplicó. 

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

Parámetros

NombreTipoDescripción
attributesObjectLos atributos del elemento.

Volver

FooterSection: Es 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 borrará el contenido existente.

Parámetros

NombreTipoDescripción
textStringEl nuevo contenido de texto.

Volver

FooterSection: Es 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 in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parámetros

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

Volver

FooterSection: Es 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