Class TableCell

TablaCelda

Un elemento que representa una celda de tabla. Un TableCell siempre se encuentra dentro de un TableRow y puede contener elementos ListItem, Paragraph o Table. Para 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
appendHorizontalRule()HorizontalRuleCrea y agrega una HorizontalRule nueva.
appendImage(image)InlineImageCrea y agrega un InlineImage nuevo a partir del blob de imagen especificado.
appendImage(image)InlineImageAgrega el InlineImage determinado.
appendListItem(listItem)ListItemAgrega el ListItem determinado.
appendListItem(text)ListItemCrea y agrega una ListItem nueva.
appendParagraph(paragraph)ParagraphAgrega el Paragraph determinado.
appendParagraph(text)ParagraphCrea y agrega una Paragraph nueva.
appendTable()TableCrea y agrega una Table nueva.
appendTable(cells)TableAgrega un nuevo Table que contiene las celdas especificadas.
appendTable(table)TableAgrega el Table determinado.
clear()TableCellBorra el contenido del elemento.
copy()TableCellMuestra una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarlo.
findElement(elementType)RangeElementBusca un descendiente del tipo especificado en el contenido del elemento.
findElement(elementType, from)RangeElementBusca un descendiente del tipo especificado en el contenido del elemento, a partir del RangeElement especificado.
findText(searchPattern)RangeElementBusca el patrón de texto especificado en el contenido del elemento con expresiones regulares.
findText(searchPattern, from)RangeElementBusca el patrón de texto especificado en el contenido del elemento, a partir de un resultado de búsqueda determinado.
getAttributes()ObjectRecupera los atributos del elemento.
getBackgroundColor()StringRecupera el color de fondo.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getColSpan()IntegerRecupera el intervalo de columnas, que es la cantidad de columnas de celdas de tabla que abarca esta celda.
getLinkUrl()StringRecupera la URL del vínculo.
getNextSibling()ElementRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getPaddingBottom()NumberRecupera el padding inferior, en puntos.
getPaddingLeft()NumberRecupera el padding izquierdo, en puntos.
getPaddingRight()NumberRecupera el padding correcto, en puntos.
getPaddingTop()NumberRecupera el padding superior, en puntos.
getParent()ContainerElementRecupera el elemento superior del elemento.
getParentRow()TableRowRecupera el TableRow que contiene el TableCell actual.
getParentTable()TableRecupera el Table que contiene el TableCell actual.
getPreviousSibling()ElementRecupera el elemento hermano anterior del elemento.
getRowSpan()IntegerRecupera el intervalo de filas, que es la cantidad de filas de celdas de tabla que abarca esta celda.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignmentObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
getVerticalAlignment()VerticalAlignmentRecupera el VerticalAlignment.
getWidth()NumberRecupera el ancho de la columna que contiene la celda, en puntos.
insertHorizontalRule(childIndex)HorizontalRuleCrea y, luego, inserta un HorizontalRule nuevo 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 determinado en el índice especificado.
insertListItem(childIndex, listItem)ListItemInserta el ListItem determinado en el índice especificado.
insertListItem(childIndex, text)ListItemCrea y, luego, inserta un ListItem nuevo en el índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInserta el Paragraph determinado en el índice especificado.
insertParagraph(childIndex, text)ParagraphCrea y, luego, inserta un Paragraph nuevo en el índice especificado.
insertTable(childIndex)TableCrea y, luego, inserta un Table nuevo 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 determinado en el índice especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()TableCellCombina el elemento con el hermano anterior del mismo tipo.
removeChild(child)TableCellQuita el elemento secundario especificado.
removeFromParent()TableCellQuita 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 con expresiones regulares.
setAttributes(attributes)TableCellEstablece los atributos del elemento.
setBackgroundColor(color)TableCellEstablece el color de fondo.
setLinkUrl(url)TableCellEstablece la URL del vínculo.
setPaddingBottom(paddingBottom)TableCellEstablece el padding inferior, en puntos.
setPaddingLeft(paddingLeft)TableCellEstablece el padding izquierdo, en puntos.
setPaddingRight(paddingRight)TableCellEstablece el padding correcto, en puntos.
setPaddingTop(paddingTop)TableCellEstablece el padding superior, en puntos.
setText(text)TableCellEstablece el contenido como texto sin formato.
setTextAlignment(textAlignment)TableCellEstablece la alineación del texto.
setVerticalAlignment(alignment)TableCellEstablece la alineación vertical.
setWidth(width)TableCellEstablece el ancho de la columna que contiene la celda actual, en puntos.

Documentación detallada

appendHorizontalRule()

Crea y agrega una HorizontalRule nueva.

El HorizontalRule se contendrá en un Paragraph nuevo.

Volver

HorizontalRule: 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 ámbitos:

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

appendImage(image)

Crea y agrega un InlineImage nuevo a partir del blob de imagen especificado.

El InlineImage se contendrá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
imageBlobSourcelos datos de la imagen

Volver

InlineImage: Es la imagen nueva.

Autorización

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

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

appendImage(image)

Agrega el InlineImage determinado.

El InlineImage se contendrá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
imageInlineImagelos 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 ámbitos:

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

appendListItem(listItem)

Agrega el ListItem determinado.

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 ámbitos:

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

appendListItem(text)

Crea y agrega una ListItem nueva.

Parámetros

NombreTipoDescripción
textStringel contenido de texto

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 ámbitos:

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

appendParagraph(paragraph)

Agrega el Paragraph determinado.

Parámetros

NombreTipoDescripción
paragraphParagraphel 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 ámbitos:

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

appendParagraph(text)

Crea y agrega una Paragraph nueva.

Parámetros

NombreTipoDescripción
textStringel contenido de texto

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 ámbitos:

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

appendTable()

Crea y agrega una Table nueva.

Volver

Table: 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 ámbitos:

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

appendTable(cells)

Agrega un nuevo Table que contiene las celdas especificadas.

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

Autorización

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

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

appendTable(table)

Agrega el Table determinado.

Parámetros

NombreTipoDescripción
tableTablela tabla a la que se adjuntará

Volver

Table: Es la tabla adjunta.

Autorización

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

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

clear()

Borra el contenido del elemento.

Volver

TableCell: 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 elemento superior.

Volver

TableCell: 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 ámbitos:

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

editAsText()

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

Usa editAsText para manipular el contenido de los elementos como texto enriquecido. El modo editAsText ignora los elementos no textuales (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: Es una versión de texto del elemento actual.


findElement(elementType)

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

Parámetros

NombreTipoDescripción
elementTypeElementTypeEs el tipo de elemento que se busca.

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 ámbitos:

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

findElement(elementType, from)

Busca un descendiente del tipo especificado en el contenido del elemento, a partir del 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 busca.
fromRangeElementEl resultado de la búsqueda desde el que se realizará 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 ámbitos:

  • 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 con expresiones regulares.

Un subconjunto de las funciones de expresión regular de JavaScript no es completamente 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 que se encuentra en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón que se busca

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de la 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 ámbitos:

  • 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 resultado de búsqueda determinado.

Un subconjunto de las funciones de expresión regular de JavaScript no es completamente 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 que se encuentra en el elemento actual.

Parámetros

NombreTipoDescripción
searchPatternStringel patrón que se busca
fromRangeElementel resultado de la búsqueda desde el que se realizará 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 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 ámbitos:

  • 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 ámbitos:

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

getBackgroundColor()

Recupera el color de fondo.

Volver

String: Es el color de fondo con formato de notación CSS (como '#ffffff').

Autorización

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

  • 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
childIndexIntegerEs el í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 ámbitos:

  • 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
childElementEs el elemento secundario para el que se debe 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 ámbitos:

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

getColSpan()

Recupera el intervalo de columnas, que es la cantidad de columnas de celdas de tabla que abarca esta celda. Las celdas no combinadas tienen un intervalo de columnas de 1.

Volver

Integer: Es el intervalo de columnas o 0 para una celda que se combina con otra.

Autorización

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

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

getLinkUrl()

Recupera la URL del vínculo.

Volver

String: Es la URL del vínculo o un valor nulo si el elemento contiene varios valores para este atributo.

Autorización

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

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

getNextSibling()

Recupera el siguiente elemento hermano del elemento.

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

Volver

Element: Es el siguiente elemento hermano.

Autorización

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

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

Autorización

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

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

getPaddingBottom()

Recupera el padding inferior, en puntos.

Volver

Number: Es el padding inferior, en puntos.

Autorización

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

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

getPaddingLeft()

Recupera el padding izquierdo, en puntos.

Volver

Number: Es el padding izquierdo, en puntos.

Autorización

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

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

getPaddingRight()

Recupera el padding correcto, en puntos.

Volver

Number: Es el padding derecho, en puntos.

Autorización

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

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

getPaddingTop()

Recupera el padding superior, en puntos.

Volver

Number: Es el padding superior, en puntos.

Autorización

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

  • 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 ámbitos:

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

getParentRow()

Recupera el TableRow que contiene el TableCell actual.

Volver

TableRow: Es la fila de la tabla que contiene la celda actual.

Autorización

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

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

getParentTable()

Recupera el Table que contiene el TableCell actual.

Volver

Table: Es la tabla que contiene la celda actual.

Autorización

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

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

getPreviousSibling()

Recupera el elemento hermano anterior del elemento.

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

Volver

Element: Es el elemento hermano anterior.

Autorización

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

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

getRowSpan()

Recupera el intervalo de filas, que es la cantidad de filas de celdas de tabla que abarca esta celda. Las celdas no combinadas tienen un intervalo de filas de 1.

Volver

Integer: Es el intervalo de filas o 0 para una celda que otra celda combina.

Autorización

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

  • 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 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 ámbitos:

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

Autorización

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

  • 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 ámbitos:

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

getVerticalAlignment()

Recupera el VerticalAlignment.

Volver

VerticalAlignment: Es la alineación vertical.

Autorización

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

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

getWidth()

Recupera el ancho de la columna que contiene la celda, en puntos.

Volver

Number: Es el ancho de la columna, en puntos.

Autorización

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

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

insertHorizontalRule(childIndex)

Crea y, luego, inserta un HorizontalRule nuevo en el índice especificado.

La línea horizontal se contendrá en un nuevo Paragraph.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento

Volver

HorizontalRule: 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 ámbitos:

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

La imagen se contendrá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
imageBlobSourcelos 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 ámbitos:

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

insertImage(childIndex, image)

Inserta el InlineImage determinado en el índice especificado.

La imagen se contendrá en un Paragraph nuevo.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
imageInlineImagela imagen que quieres 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 ámbitos:

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

insertListItem(childIndex, listItem)

Inserta el ListItem determinado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
listItemListItemel elemento de lista que se insertará

Volver

ListItem: Se insertó un nuevo elemento de lista.

Autorización

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

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

insertListItem(childIndex, text)

Crea y, luego, inserta un ListItem nuevo en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
textStringel contenido de texto

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 ámbitos:

  • 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á el elemento
paragraphParagraphel párrafo que deseas 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 ámbitos:

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

insertParagraph(childIndex, text)

Crea y, luego, inserta un Paragraph nuevo en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
textStringel contenido de texto

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 ámbitos:

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

insertTable(childIndex)

Crea y, luego, inserta un Table nuevo en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento

Volver

Table: 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 ámbitos:

  • 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
childIndexIntegerel índice en el que se debe insertar
cellsString[][]el contenido de texto de las celdas de la tabla que se agregarán a la tabla nueva

Volver

Table: 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 ámbitos:

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

insertTable(childIndex, table)

Inserta el Table determinado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
tableTablela tabla que se va a 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 ámbitos:

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

isAtDocumentEnd()

Determina si el elemento está al final de 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 ámbitos:

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

merge()

Combina el elemento con el hermano anterior del mismo tipo.

Solo se pueden combinar elementos del mismo ElementType. Todos los elementos secundarios que se encuentran en el elemento actual se mueven al elemento hermano anterior.

Se quita el elemento actual del documento.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Volver

TableCell: Es el elemento combinado.

Autorización

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

  • 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

TableCell: 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 ámbitos:

  • 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

TableCell: 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 ámbitos:

  • 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 con 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 del 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 que se encuentra 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: 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 ámbitos:

  • 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

NombreTipoDescripción
attributesObjectLos atributos del elemento

Volver

TableCell: 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 ámbitos:

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

setBackgroundColor(color)

Establece el color de fondo.

Parámetros

NombreTipoDescripción
colorStringel color de fondo, con formato de notación CSS (como '#ffffff')

Volver

TableCell: 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 ámbitos:

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

setLinkUrl(url)

Establece la URL del vínculo.

Parámetros

NombreTipoDescripción
urlStringla URL del vínculo

Volver

TableCell: 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 ámbitos:

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

setPaddingBottom(paddingBottom)

Establece el padding inferior, en puntos.

Parámetros

NombreTipoDescripción
paddingBottomNumberel padding inferior, en puntos

Volver

TableCell: 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 ámbitos:

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

setPaddingLeft(paddingLeft)

Establece el padding izquierdo, en puntos.

Parámetros

NombreTipoDescripción
paddingLeftNumberEs el padding izquierdo, en puntos.

Volver

TableCell: 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 ámbitos:

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

setPaddingRight(paddingRight)

Establece el padding correcto, en puntos.

Parámetros

NombreTipoDescripción
paddingRightNumberEs el padding derecho, en puntos.

Volver

TableCell: 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 ámbitos:

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

setPaddingTop(paddingTop)

Establece el padding superior, en puntos.

Parámetros

NombreTipoDescripción
paddingTopNumberEl padding superior, en puntos

Volver

TableCell: 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 ámbitos:

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

setText(text)

Establece el contenido como texto sin formato.

Nota: Se borra el contenido existente.

Parámetros

NombreTipoDescripción
textStringel nuevo contenido de texto

Volver

TableCell: 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 ámbitos:

  • 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

TableCell: 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 ámbitos:

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

setVerticalAlignment(alignment)

Establece la alineación vertical.

Parámetros

NombreTipoDescripción
alignmentVerticalAlignmentla alineación vertical

Volver

TableCell: 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 ámbitos:

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

setWidth(width)

Establece el ancho de la columna que contiene la celda actual, en puntos.

Parámetros

NombreTipoDescripción
widthNumberEl ancho de la columna, en puntos

Volver

TableCell: 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 ámbitos:

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