Class HeaderSection

EncabezadoSección

Es un elemento que representa una sección de encabezado. Por lo general, un Document contiene como máximo un HeaderSection. El elemento HeaderSection puede contener elementos ListItem, Paragraph y Table. Para obtener más información sobre la estructura de los documentos, consulta la guía para extender Google Docs.

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega un nuevo ListItem que contiene el contenido de texto especificado.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega un nuevo Paragraph que contiene el contenido de texto especificado.
appendTable()TableCrea y agrega un nuevo Table.
appendTable(cells)TableAnexa un nuevo Table que contiene un TableCell para cada valor de cadena especificado.
appendTable(table)TableAgrega el Table determinado.
clear()HeaderSectionBorra el contenido del elemento.
copy()HeaderSectionDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde 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 del elemento secundario especificado.
getImages()InlineImage[]|nullRecupera todos los InlineImages incluidos en la sección.
getListItems()ListItem[]|nullRecupera todos los ListItems incluidos en la sección.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParagraphs()Paragraph[]|nullRecupera todos los Paragraphs incluidos en la sección (incluido ListItems).
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getTables()Table[]|nullRecupera todos los Tables incluidos en la sección.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un nuevo HorizontalRule en el índice especificado.
insertImage(childIndex, image)InlineImageCrea e inserta un InlineImage a partir del blob de imagen especificado en el índice especificado.
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 nuevo ListItem en el índice especificado, que contiene el contenido de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph proporcionado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea e inserta un nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.
insertTable(childIndex)TableCrea e inserta un nuevo Table en el índice especificado.
insertTable(childIndex, cells)TableCrea e inserta un nuevo Table que contiene las celdas especificadas en el índice especificado.
insertTable(childIndex, table)TableInserta el Table proporcionado en el índice especificado.
removeChild(child)HeaderSectionQuita el elemento secundario especificado.
removeFromParent()HeaderSection|nullQuita el elemento de su elemento superior.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAttributes(attributes)HeaderSectionEstablece los atributos del elemento.
setText(text)HeaderSectionEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)HeaderSectionEstablece la alineación del texto.

Documentación detallada

appendHorizontalRule()

Crea y agrega un nuevo HorizontalRule.

El HorizontalRule se incluirá 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 nuevo InlineImage a partir del blob de imagen especificado.

La imagen se incluirá en un nuevo Paragraph.

Parámetros

NombreTipoDescripción
imageBlobSourceSon los datos de la imagen.

Volver

InlineImage: Es la imagen adjunta.

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

El InlineImage se incluirá en un nuevo Paragraph.

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

Parámetros

NombreTipoDescripción
imageInlineImageSon los datos de la imagen.

Volver

InlineImage: Es la imagen adjunta.

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

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

Parámetros

NombreTipoDescripción
listItemListItemEs el elemento de lista que se agregará.

Volver

ListItem: Es el elemento de la lista que se agregó.

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 nuevo ListItem que contiene el contenido de texto especificado.

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

Parámetros

NombreTipoDescripción
textStringContenido de texto del elemento de la lista.

Volver

ListItem: Es el nuevo elemento de la lista.

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

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

Parámetros

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

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 nuevo Paragraph que contiene el contenido de texto especificado.

Parámetros

NombreTipoDescripción
textStringEs el contenido de 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 nuevo Table.

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

Anexa un nuevo Table que contiene un 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 pueden terminar con una tabla.

Parámetros

NombreTipoDescripción
cellsString[][]Es 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 determinado.

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 pueden terminar con una tabla.

Parámetros

NombreTipoDescripción
tableTableTabla que se anexará.

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

HeaderSection: Es el elemento actual.

copy()

Devuelve una copia profunda y separada del elemento actual.

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

Volver

HeaderSection: 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 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 completamente dentro de un rango de texto borrado se quitan del elemento. 

const 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: Una versión de texto del elemento actual

findElement(elementType)

Busca en el contenido del elemento un elemento secundario del tipo especificado.

Parámetros

NombreTipoDescripción
elementTypeElementTypeEs el tipo de elemento que se buscará.

Volver

RangeElement|null: 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 secundario del tipo especificado, comenzando desde el RangeElement especificado. 

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parámetros

NombreTipoDescripción
elementTypeElementTypeEs el tipo de elemento que se buscará.
fromRangeElementEs el resultado de la búsqueda desde el que se realizará la búsqueda.

Volver

RangeElement|null: 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 en el contenido del elemento el patrón de texto especificado con expresiones regulares.

No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, 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 incluido en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringEl patrón que se debe buscar

Volver

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

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, comenzando desde un resultado de búsqueda determinado.

No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, 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 incluido en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringEl patrón que se debe buscar
fromRangeElementEl resultado de la búsqueda desde el que se realizará la búsqueda

Volver

RangeElement|null: Un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o un valor nulo si no hay coincidencias

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 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: 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 en el índice secundario especificado. 

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

// Obtain the first element in the tab.
const 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
childIndexIntegerÍ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
childElementElemento secundario para el que se recuperará 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 incluidos en la sección.

Volver

InlineImage[]|null: 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 incluidos en la sección.

Volver

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

getNumChildren()

Recupera la cantidad de elementos secundarios. 

const 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 hijos.

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 incluidos en la sección (incluido ListItems).

Volver

Paragraph[]|null: 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 principal del elemento.

El elemento principal contiene el elemento actual.

Volver

ContainerElement|null: 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

getTables()

Recupera todos los Tables incluidos en la sección.

Volver

Table[]|null: Son las tablas 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

getText()

Recupera el contenido del elemento como una cadena de texto.

Volver

String: Contenido del elemento como 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|null: Es el tipo de alineación del texto o null si el texto contiene varios tipos de alineación o si nunca se configuró 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. 

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: 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 nuevo HorizontalRule en el índice especificado.

El HorizontalRule se incluirá en un nuevo Paragraph.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará 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 a partir del blob de imagen especificado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.
imageBlobSourceSon los datos de la imagen.

Volver

InlineImage: Es la imagen intercalada insertada.

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 nuevo Paragraph.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.
imageInlineImageImagen que se insertará.

Volver

InlineImage: Es la imagen intercalada insertada.

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
childIndexIntegerÍndice en el que se insertará el elemento.
listItemListItemEs el elemento de lista que se insertará.

Volver

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

insertListItem(childIndex, text)

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

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.
textStringContenido de texto del elemento de la lista.

Volver

ListItem: Es el nuevo elemento de la lista.

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
childIndexIntegerÍndice en el que se insertará el elemento.
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 nuevo Paragraph en el índice especificado, que contiene el contenido de texto especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.
textStringEs el contenido de 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 nuevo Table en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.

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 contiene las celdas especificadas en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento.
cellsString[][]Es 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
childIndexIntegerÍndice en el que se insertará el elemento.
tableTableEs la tabla que se insertará.

Volver

Table: Es la tabla insertada.

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
childElementEs el elemento secundario que se quitará.

Volver

HeaderSection: 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. 

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

HeaderSection|null: Es 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 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 determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.

El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Por lo tanto, deberás escapar las barras inversas en el patrón.

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

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

const 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 que se debe 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 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 nuevo valor 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

NombreTipoDescripción
attributesObjectSon los atributos del elemento.

Volver

HeaderSection: 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
textStringEs el contenido de texto nuevo.

Volver

HeaderSection: 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.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const 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

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