Elemento que representa una celda de una tabla. Un TableCell
siempre se encuentra dentro de un TableRow
y puede contener elementos ListItem
, Paragraph
o Table
. Si quieres obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea y agrega un HorizontalRule nuevo. |
appendImage(image) | InlineImage | Crea y agrega un InlineImage nuevo desde el BLOB de imágenes especificado. |
appendImage(image) | InlineImage | Agrega el InlineImage determinado. |
appendListItem(listItem) | ListItem | Agrega el ListItem determinado. |
appendListItem(text) | ListItem | Crea y agrega un ListItem nuevo. |
appendParagraph(paragraph) | Paragraph | Agrega el Paragraph determinado. |
appendParagraph(text) | Paragraph | Crea y agrega un Paragraph nuevo. |
appendTable() | Table | Crea y agrega un Table nuevo. |
appendTable(cells) | Table | Agrega una Table nueva que contenga las celdas especificadas. |
appendTable(table) | Table | Agrega el Table determinado. |
clear() | TableCell | Borra el contenido del elemento. |
copy() | TableCell | Muestra una copia profunda y separada del elemento actual. |
editAsText() | Text | Obtiene una versión Text del elemento actual para editarlo. |
findElement(elementType) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado. |
findElement(elementType, from) | RangeElement | Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement especificado. |
findText(searchPattern) | RangeElement | Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares. |
findText(searchPattern, from) | RangeElement | Busca en el contenido del elemento el patrón de texto especificado a partir de un resultado de la búsqueda determinado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getBackgroundColor() | String | Recupera el color de fondo. |
getChild(childIndex) | Element | Recupera el elemento secundario en el índice secundario especificado. |
getChildIndex(child) | Integer | Recupera el índice secundario para el elemento secundario especificado. |
getColSpan() | Integer | Recupera el intervalo de columnas, que es el número de columnas de celdas de la tabla que abarca esta celda. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento del mismo nivel del elemento. |
getNumChildren() | Integer | Recupera la cantidad de elementos secundarios. |
getPaddingBottom() | Number | Recupera el padding inferior, en puntos. |
getPaddingLeft() | Number | Recupera el padding izquierdo, en puntos. |
getPaddingRight() | Number | Recupera el padding correcto, en puntos. |
getPaddingTop() | Number | Recupera el padding superior, en puntos. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getParentRow() | TableRow | Recupera el TableRow que contiene el TableCell actual. |
getParentTable() | Table | Recupera el Table que contiene el TableCell actual. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getRowSpan() | Integer | Recupera el intervalo de filas, que es el número de filas de celdas de la tabla que abarca esta celda. |
getText() | String | Recupera el contenido del elemento como una string de texto. |
getTextAlignment() | TextAlignment | Obtiene la alineación del texto. |
getType() | ElementType | Recupera el ElementType del elemento. |
getVerticalAlignment() | VerticalAlignment | Recupera el VerticalAlignment . |
getWidth() | Number | Recupera el ancho de la columna que contiene la celda, en puntos. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea y, luego, inserta un nuevo HorizontalRule en el índice especificado. |
insertImage(childIndex, image) | InlineImage | Crea y, luego, inserta un InlineImage desde el BLOB de imágenes especificado en el índice indicado. |
insertImage(childIndex, image) | InlineImage | Inserta el elemento InlineImage determinado en el índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Inserta el elemento ListItem determinado en el índice especificado. |
insertListItem(childIndex, text) | ListItem | Crea y, luego, inserta un nuevo ListItem en el índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserta el elemento Paragraph determinado en el índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Crea y, luego, inserta un nuevo Paragraph en el índice especificado. |
insertTable(childIndex) | Table | Crea y, luego, inserta un nuevo Table en el índice especificado. |
insertTable(childIndex, cells) | Table | Crea y, luego, inserta un nuevo Table que contiene las celdas especificadas en el índice especificado. |
insertTable(childIndex, table) | Table | Inserta el elemento Table determinado en el índice especificado. |
isAtDocumentEnd() | Boolean | Determina si el elemento se encuentra al final de Document . |
merge() | TableCell | Combina el elemento con el elemento del mismo nivel anterior del mismo tipo. |
removeChild(child) | TableCell | Quita el elemento secundario especificado. |
removeFromParent() | TableCell | Quita el elemento de su elemento superior. |
replaceText(searchPattern, replacement) | Element | Reemplaza todos los casos de un patrón de texto determinado por una string de reemplazo determinada mediante expresiones regulares. |
setAttributes(attributes) | TableCell | Establece los atributos del elemento. |
setBackgroundColor(color) | TableCell | Establece el color de fondo. |
setLinkUrl(url) | TableCell | Establece la URL del vínculo. |
setPaddingBottom(paddingBottom) | TableCell | Establece el padding inferior, en puntos. |
setPaddingLeft(paddingLeft) | TableCell | Establece el padding izquierdo, en puntos. |
setPaddingRight(paddingRight) | TableCell | Establece el padding correcto, en puntos. |
setPaddingTop(paddingTop) | TableCell | Establece el padding superior, en puntos. |
setText(text) | TableCell | Establece el contenido como texto sin formato. |
setTextAlignment(textAlignment) | TableCell | Establece la alineación del texto. |
setVerticalAlignment(alignment) | TableCell | Establece la alineación vertical. |
setWidth(width) | TableCell | Establece el ancho, en puntos, de la columna que contiene la celda actual. |
Documentación detallada
appendHorizontalRule()
Crea y agrega un HorizontalRule
nuevo.
El HorizontalRule
se incluirá en un Paragraph
nuevo.
Devolvedor
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 imágenes especificado.
El InlineImage
se incluirá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | BlobSource | los datos de la imagen |
Devolvedor
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 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 Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
image | InlineImage | los datos de la imagen |
Devolvedor
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.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
listItem | ListItem | el elemento de la lista que se agregará |
Devolvedor
ListItem
: Es el elemento de lista adjunto.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
Crea y agrega un ListItem
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el contenido del texto |
Devolvedor
ListItem
: Es el 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Agrega el Paragraph
determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paragraph | Paragraph | el párrafo para anexar |
Devolvedor
Paragraph
: El párrafo adjunto
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Crea y agrega un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el contenido del texto |
Devolvedor
Paragraph
: Es el nuevo párrafo.
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()
appendTable(cells)
Agrega una Table
nueva que contenga las celdas especificadas.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
cells | String[][] | el contenido de texto de las celdas de la tabla para agregar a la nueva tabla |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Agrega el Table
determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
table | Table | la tabla para adjuntar |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Muestra 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 superior.
Devolvedor
TableCell
: Es la nueva copia.
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 editarlo.
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 completamente contenidos en un rango de texto borrado se quitan del elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Devolvedor
Text
: Es una versión de texto del elemento actual.
findElement(elementType)
Busca en el contenido del elemento un elemento subordinado del tipo especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | el tipo de elemento que se buscará |
Devolvedor
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 a partir del RangeElement
especificado.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
elementType | ElementType | el tipo de elemento que se buscará |
from | RangeElement | el resultado de la búsqueda desde |
Devolvedor
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 en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la posición del texto de búsqueda, o nulo si no hay una 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 en el contenido del elemento el patrón de texto especificado a partir de un resultado de la búsqueda determinado.
Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como los grupos de captura y los modificadores de modo.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón a buscar |
from | RangeElement | el resultado de la búsqueda desde |
Devolvedor
RangeElement
: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda, o nulo si no hay una 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 nombre de propiedad corresponde a un elemento en la enumeración DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Devolvedor
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
getBackgroundColor()
Recupera el color de fondo.
Devolvedor
String
: Es el color de fondo, con formato en 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera el elemento secundario en el índice secundario especificado.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice del elemento secundario para recuperar |
Devolvedor
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 para el elemento secundario especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Element | el elemento secundario para el que se recupera el índice |
Devolvedor
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
getColSpan()
Recupera el intervalo de columnas, que es el número de columnas de celdas de la tabla que abarca esta celda. Las celdas no combinadas tienen un intervalo de columna de 1.
Devolvedor
Integer
: Es el intervalo de columnas o 0 de una celda combinada por otra celda.
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
getLinkUrl()
Recupera la URL del vínculo.
Devolvedor
String
: Es la URL del vínculo, o 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera el siguiente elemento del mismo nivel del elemento.
El siguiente elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.
Devolvedor
Element
: Es el siguiente elemento del mismo nivel.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera la cantidad de elementos secundarios.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Devolvedor
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
getPaddingBottom()
Recupera el padding inferior, en puntos.
Devolvedor
Number
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingLeft()
Recupera el padding izquierdo, en puntos.
Devolvedor
Number
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingRight()
Recupera el padding correcto, en puntos.
Devolvedor
Number
: El padding correcto, en puntos
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
getPaddingTop()
Recupera el padding superior, en puntos.
Devolvedor
Number
: 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera el elemento principal del elemento.
El elemento superior contiene el elemento actual.
Devolvedor
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
getParentRow()
Recupera el TableRow
que contiene el TableCell
actual.
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParentTable()
Recupera el Table
que contiene el TableCell
actual.
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Recupera el elemento del mismo nivel anterior del elemento.
El elemento del mismo nivel anterior tiene el mismo elemento superior y antecede al elemento actual.
Devolvedor
Element
: Es el elemento del mismo nivel anterior.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRowSpan()
Recupera el intervalo de filas, que es el número de filas de celdas de la tabla que abarca esta celda. Las celdas no combinadas tienen un intervalo de filas de 1.
Devolvedor
Integer
: El intervalo de filas o 0 para una celda combinada por otra celda
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Recupera el contenido del elemento como una string de texto.
Devolvedor
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
.
Devolvedor
TextAlignment
: Es el tipo de alineación del texto, o null
si el texto contiene varios tipos de alineaciones de texto 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 body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Devolvedor
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
getVerticalAlignment()
Recupera el VerticalAlignment
.
Devolvedor
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 alcances:
-
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.
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crea y, luego, inserta un nuevo HorizontalRule
en el índice especificado.
La regla horizontal se incluirá en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
Devolvedor
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 y, luego, inserta un InlineImage
desde el BLOB de imágenes especificado en el índice indicado.
La imagen estará contenida en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | BlobSource | los datos de la imagen |
Devolvedor
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 elemento InlineImage
determinado en el índice especificado.
La imagen estará contenida en un Paragraph
nuevo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
image | InlineImage | la imagen que se insertará |
Devolvedor
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 elemento ListItem
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
listItem | ListItem | el elemento de la lista que se insertará |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
Crea y, luego, inserta un nuevo ListItem
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
text | String | el contenido del texto |
Devolvedor
ListItem
: Es el 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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Inserta el elemento Paragraph
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
paragraph | Paragraph | el párrafo para insertar |
Devolvedor
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 y, luego, inserta un nuevo Paragraph
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
text | String | el contenido del texto |
Devolvedor
Paragraph
: Es el nuevo párrafo.
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 y, luego, inserta un nuevo Table
en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
Devolvedor
Table
: La nueva tabla
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 y, luego, inserta un nuevo Table
que contiene las celdas especificadas en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará |
cells | String[][] | el contenido de texto de las celdas de la tabla para agregar a la nueva tabla |
Devolvedor
Table
: La nueva tabla
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 elemento Table
determinado en el índice especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
childIndex | Integer | el índice en el que se insertará el elemento |
table | Table | la tabla para insertar |
Devolvedor
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
isAtDocumentEnd()
Determina si el elemento se encuentra al final de Document
.
Devolvedor
Boolean
: Indica si el elemento está al final del documento.
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
merge()
Combina el elemento con el elemento del mismo nivel anterior del mismo tipo.
Solo se pueden combinar elementos del mismo ElementType
. Todos los elementos secundarios contenidos en el elemento actual se mueven al elemento del mismo nivel anterior.
El elemento actual se quita del documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var 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. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Quita el elemento secundario especificado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
child | Element | el elemento secundario quitar |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Quita el elemento de su elemento superior.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Devolvedor
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 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 string de reemplazo determinada mediante expresiones regulares.
El patrón de búsqueda se pasa como una string y 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 la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis compatible.
El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
searchPattern | String | el patrón de regex para buscar |
replacement | String | el texto que se utilizará como reemplazo |
Devolvedor
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 de la enumeración DocumentApp.Attribute
y cada valor de propiedad sea el valor nuevo que se aplicará.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | Los atributos del elemento. |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBackgroundColor(color)
Establece el color de fondo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
color | String | el color de fondo, con el formato de notación CSS (como '#ffffff' ) |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Establece la URL del vínculo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
url | String | la URL del vínculo |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingBottom(paddingBottom)
Establece el padding inferior, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paddingBottom | Number | el padding inferior, en puntos |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingLeft(paddingLeft)
Establece el padding izquierdo, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paddingLeft | Number | el padding izquierdo, en puntos |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingRight(paddingRight)
Establece el padding correcto, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paddingRight | Number | El padding correcto, en puntos. |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingTop(paddingTop)
Establece el padding superior, en puntos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
paddingTop | Number | el padding superior, en puntos |
Devolvedor
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 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 borra el contenido existente.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | String | el nuevo contenido de texto |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Establece la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
y DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
textAlignment | TextAlignment | el tipo de alineación de texto que se aplicará |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setVerticalAlignment(alignment)
Establece la alineación vertical.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
alignment | VerticalAlignment | la alineación vertical |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
Establece el ancho, en puntos, de la columna que contiene la celda actual.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
width | Number | el ancho de columna, en puntos |
Devolvedor
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 alcances:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents