Class Body

Es el contenido de una pestaña en un documento de Documentos de Google. El elemento Body puede contener elementos ListItem, Paragraph, Table y TableOfContents. Para obtener más información sobre la estructura del documento, consulta la guía para extender Documentos de Google.

Por lo general, el Body contiene todo el contenido de la pestaña, excepto los elementos HeaderSection, FooterSection y cualquier elemento FootnoteSection.

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
`appendHorizontalRule()`	`HorizontalRule`	Crea y agrega un nuevo `HorizontalRule`.
`appendImage(image)`	`InlineImage`	Crea y agrega un nuevo `InlineImage` a partir del blob de imagen especificado.
`appendImage(image)`	`InlineImage`	Agrega el `InlineImage` determinado.
`appendListItem(listItem)`	`ListItem`	Agrega el `ListItem` determinado.
`appendListItem(text)`	`ListItem`	Crea y agrega un nuevo `ListItem` que contiene el contenido de texto especificado.
`appendPageBreak()`	`PageBreak`	Crea y agrega un nuevo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Agrega el `PageBreak` determinado.
`appendParagraph(paragraph)`	`Paragraph`	Agrega el `Paragraph` determinado.
`appendParagraph(text)`	`Paragraph`	Crea y agrega un nuevo `Paragraph` que contiene el contenido de texto especificado.
`appendTable()`	`Table`	Crea y agrega un nuevo `Table`.
`appendTable(cells)`	`Table`	Anexa un nuevo `Table` que contiene un `TableCell` para cada valor de cadena especificado.
`appendTable(table)`	`Table`	Agrega el `Table` determinado.
`clear()`	`Body`	Borra el contenido del elemento.
`copy()`	`Body`	Devuelve una copia profunda y separada del elemento actual.
`editAsText()`	`Text`	Obtiene una versión `Text` del elemento actual para editarla.
`findElement(elementType)`	`RangeElement\|null`	Busca en el contenido del elemento un elemento secundario del tipo especificado.
`findElement(elementType, from)`	`RangeElement\|null`	Busca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement\|null`	Busca el patrón de texto especificado en el contenido del elemento con expresiones regulares.
`findText(searchPattern, from)`	`RangeElement\|null`	Busca el patrón de texto especificado en el contenido del elemento a partir de un resultado de búsqueda determinado.
`getAttributes()`	`Object`	Recupera los atributos del elemento.
`getChild(childIndex)`	`Element`	Recupera el elemento secundario en el índice secundario especificado.
`getChildIndex(child)`	`Integer`	Recupera el índice secundario del elemento secundario especificado.
`getHeadingAttributes(paragraphHeading)`	`Object`	Recupera el conjunto de atributos para el `ParagraphHeading` proporcionado.
`getImages()`	`InlineImage[]\|null`	Recupera todos los `InlineImages` incluidos en la sección.
`getListItems()`	`ListItem[]\|null`	Recupera todos los `ListItems` incluidos en la sección.
`getMarginBottom()`	`Number\|null`	Recupera el margen inferior, en puntos.
`getMarginLeft()`	`Number\|null`	Recupera el margen izquierdo, en puntos.
`getMarginRight()`	`Number\|null`	Recupera el margen derecho.
`getMarginTop()`	`Number\|null`	Recupera el margen superior.
`getNumChildren()`	`Integer`	Recupera la cantidad de elementos secundarios.
`getPageHeight()`	`Number\|null`	Recupera la altura de la página, en puntos.
`getPageWidth()`	`Number\|null`	Recupera el ancho de la página, en puntos.
`getParagraphs()`	`Paragraph[]\|null`	Recupera todos los `Paragraphs` incluidos en la sección (incluido `ListItems`).
`getParent()`	`ContainerElement\|null`	Recupera el elemento principal del elemento.
`getTables()`	`Table[]\|null`	Recupera todos los `Tables` incluidos en la sección.
`getText()`	`String`	Recupera el contenido del elemento como una cadena de texto.
`getTextAlignment()`	`TextAlignment\|null`	Obtiene la alineación del texto.
`getType()`	`ElementType`	Recupera el `ElementType` del elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crea e inserta un nuevo `HorizontalRule` en el índice especificado.
`insertImage(childIndex, image)`	`InlineImage`	Crea e inserta un `InlineImage` a partir del blob de imagen especificado en el índice especificado.
`insertImage(childIndex, image)`	`InlineImage`	Inserta el `InlineImage` proporcionado en el índice especificado.
`insertListItem(childIndex, listItem)`	`ListItem`	Inserta el `ListItem` proporcionado en el índice especificado.
`insertListItem(childIndex, text)`	`ListItem`	Crea e inserta un nuevo `ListItem` en el índice especificado, que contiene el contenido de texto especificado.
`insertPageBreak(childIndex)`	`PageBreak`	Crea e inserta un nuevo `PageBreak` en el índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Inserta el `PageBreak` proporcionado en el índice especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Inserta el `Paragraph` proporcionado en el índice especificado.
`insertParagraph(childIndex, text)`	`Paragraph`	Crea e inserta un nuevo `Paragraph` en el índice especificado, que contiene el contenido de texto especificado.
`insertTable(childIndex)`	`Table`	Crea e inserta un nuevo `Table` en el índice especificado.
`insertTable(childIndex, cells)`	`Table`	Crea e inserta un nuevo `Table` que contiene las celdas especificadas en el índice especificado.
`insertTable(childIndex, table)`	`Table`	Inserta el `Table` proporcionado en el índice especificado.
`removeChild(child)`	`Body`	Quita el elemento secundario especificado.
`replaceText(searchPattern, replacement)`	`Element`	Reemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
`setAttributes(attributes)`	`Body`	Establece los atributos del elemento.
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	Establece los atributos para el `ParagraphHeading` proporcionado.
`setMarginBottom(marginBottom)`	`Body`	Establece el margen inferior, en puntos.
`setMarginLeft(marginLeft)`	`Body`	Establece el margen izquierdo, en puntos.
`setMarginRight(marginRight)`	`Body`	Establece el margen derecho, en puntos.
`setMarginTop(marginTop)`	`Body`	Establece el margen superior.
`setPageHeight(pageHeight)`	`Body`	Establece la altura de la página en puntos.
`setPageWidth(pageWidth)`	`Body`	Establece el ancho de la página en puntos.
`setText(text)`	`Body`	Establece el contenido como texto sin formato.
`setTextAlignment(textAlignment)`	`Body`	Establece la alineación del texto.

Métodos obsoletos

Método	Tipo de datos que se devuelve	Descripción breve
`getFootnotes()`	`Footnote[]\|null`	Recupera todos los `Footnotes` incluidos en la sección.
`getLinkUrl()`	`String\|null`	Recupera la URL del vínculo.
`getNextSibling()`	`Element\|null`	Recupera el siguiente elemento hermano del elemento.
`getPreviousSibling()`	`Element\|null`	Recupera el elemento hermano anterior del elemento.
`isAtDocumentEnd()`	`Boolean`	Determina si el elemento está al final de `Document`.
`setLinkUrl(url)`	`Body`	Establece la URL del vínculo.

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

Nombre	Tipo	Descripción
`image`	`BlobSource`	Son 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

Nombre	Tipo	Descripción
`image`	`InlineImage`	Son 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

Nombre	Tipo	Descripción
`listItem`	`ListItem`	Es 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

Nombre	Tipo	Descripción
`text`	`String`	Contenido 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

`appendPageBreak()`

Crea y agrega un nuevo PageBreak.

El PageBreak se incluirá en un nuevo Paragraph.

Volver

PageBreak: Es el nuevo salto de página.

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

`appendPageBreak(pageBreak)`

Agrega el PageBreak determinado.

El PageBreak se incluirá en un nuevo Paragraph.

Usa esta versión de appendPageBreak cuando agregues una copia de un PageBreak existente.

Parámetros

Nombre	Tipo	Descripción
`pageBreak`	`PageBreak`	Es el salto de página que se agregará.

Volver

PageBreak: Es el salto de página 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(paragraph)`

Agrega el Paragraph determinado.

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

Parámetros

Nombre	Tipo	Descripción
`paragraph`	`Paragraph`	Es 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

Nombre	Tipo	Descripción
`text`	`String`	Es 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

Nombre	Tipo	Descripción
`cells`	`String[][]`	Es el contenido de texto de las celdas de la tabla que se agregará 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

Nombre	Tipo	Descripción
`table`	`Table`	Tabla 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

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

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

Nombre	Tipo	Descripción
`elementType`	`ElementType`	Es 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

Nombre	Tipo	Descripción
`elementType`	`ElementType`	Es el tipo de elemento que se buscará.
`from`	`RangeElement`	Es 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 el patrón de texto especificado en el contenido del elemento 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

Nombre	Tipo	Descripción
`searchPattern`	`String`	El 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 a partir de 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

Nombre	Tipo	Descripción
`searchPattern`	`String`	El patrón que se debe buscar
`from`	`RangeElement`	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 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Í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

Nombre	Tipo	Descripción
`child`	`Element`	Elemento 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

`getHeadingAttributes(paragraphHeading)`

Recupera el conjunto de atributos para el ParagraphHeading proporcionado.

Parámetros

Nombre	Tipo	Descripción
`paragraphHeading`	`ParagraphHeading`	Es el encabezado cuyos atributos se deben recuperar.

Volver

Object: Es un mapa de los atributos y sus valores actuales.

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

`getMarginBottom()`

Recupera el margen inferior, en puntos.

Volver

Number|null: Es el margen 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

`getMarginLeft()`

Recupera el margen izquierdo, en puntos.

Volver

Number|null: Es el margen 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

`getMarginRight()`

Recupera el margen derecho.

Volver

Number|null: Es el margen 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 alcances:

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

`getMarginTop()`

Recupera el margen superior.

Volver

Number|null: Es el margen 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

`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

`getPageHeight()`

Recupera la altura de la página, en puntos.

Volver

Number|null: La altura de la página, 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

`getPageWidth()`

Recupera el ancho de la página, en puntos.

Volver

Number|null: Es el ancho de la página 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

`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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Í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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`image`	`BlobSource`	Son 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`image`	`InlineImage`	Imagen 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`listItem`	`ListItem`	Es 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`text`	`String`	Contenido 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

`insertPageBreak(childIndex)`

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

El PageBreak se incluirá en un nuevo Paragraph.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.

Volver

PageBreak: Es el nuevo salto de página.

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

`insertPageBreak(childIndex, pageBreak)`

Inserta el PageBreak proporcionado en el índice especificado.

El PageBreak se incluirá en un nuevo Paragraph.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`pageBreak`	`PageBreak`	Es el salto de página que se insertará.

Volver

PageBreak: Es el salto de página 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, paragraph)`

Inserta el Paragraph proporcionado en el índice especificado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`paragraph`	`Paragraph`	Es 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`text`	`String`	Es 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Í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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`cells`	`String[][]`	Es el contenido de texto de las celdas de la tabla que se agregará 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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Índice en el que se insertará el elemento.
`table`	`Table`	Es 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

Nombre	Tipo	Descripción
`child`	`Element`	Es el elemento secundario que se quitará.

Volver

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

`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 este motivo, deberás escapar todas 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 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

Nombre	Tipo	Descripción
`searchPattern`	`String`	El patrón de regex que se debe buscar
`replacement`	`String`	El texto que se usará como reemplazo

Volver

Element: El elemento actual

Autorización

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

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

`setAttributes(attributes)`

Establece los atributos del elemento.

El parámetro de atributos especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento 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

Nombre	Tipo	Descripción
`attributes`	`Object`	Son los atributos del elemento.

Volver

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

`setHeadingAttributes(paragraphHeading, attributes)`

Establece los atributos para el ParagraphHeading proporcionado.

Parámetros

Nombre	Tipo	Descripción
`paragraphHeading`	`ParagraphHeading`	Es el encabezado cuyos atributos se deben establecer.
`attributes`	`Object`	Es un mapa de atributos y los valores que se deben establecer para ellos.

Volver

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

`setMarginBottom(marginBottom)`

Establece el margen inferior, en puntos.

Parámetros

Nombre	Tipo	Descripción
`marginBottom`	`Number`	Es el margen inferior, en puntos.

Volver

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

`setMarginLeft(marginLeft)`

Establece el margen izquierdo, en puntos.

Parámetros

Nombre	Tipo	Descripción
`marginLeft`	`Number`	Es el margen izquierdo, en puntos.

Volver

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

`setMarginRight(marginRight)`

Establece el margen derecho, en puntos.

Parámetros

Nombre	Tipo	Descripción
`marginRight`	`Number`	Es el margen derecho.

Volver

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

`setMarginTop(marginTop)`

Establece el margen superior.

Parámetros

Nombre	Tipo	Descripción
`marginTop`	`Number`	Es el margen superior, en puntos.

Volver

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

`setPageHeight(pageHeight)`

Establece la altura de la página en puntos.

Parámetros

Nombre	Tipo	Descripción
`pageHeight`	`Number`	Es la altura de la página, en puntos.

Volver

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

`setPageWidth(pageWidth)`

Establece el ancho de la página en puntos.

Parámetros

Nombre	Tipo	Descripción
`pageWidth`	`Number`	Ancho de la página, en puntos.

Volver

Body: 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`	Es el contenido de texto nuevo.

Volver

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

Nombre	Tipo	Descripción
`textAlignment`	`TextAlignment`	El tipo de alineación de texto que se aplicará

Volver

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

`getFootnotes()`

Obsoleto. Este elemento no puede contener un Footnote.

Recupera todos los Footnotes incluidos en la sección.

Volver

Footnote[]|null: Son las notas al pie 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

`getLinkUrl()`

Obsoleto. En lugar de aplicar un vínculo a toda una sección, aplícalo a un elemento dentro de la sección.

Recupera la URL del vínculo.

Volver

String|null: Es la URL del vínculo o nula 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()`

Obsoleto. Este elemento no tiene hermanos.

Recupera el siguiente elemento hermano del elemento.

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

Volver

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

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

`getPreviousSibling()`

Obsoleto. Este elemento no tiene hermanos.

Recupera el elemento hermano anterior del elemento.

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

Volver

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

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

`isAtDocumentEnd()`

Obsoleto. Este método no es confiable para HeaderSection.

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

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

`setLinkUrl(url)`

Obsoleto. En lugar de aplicar un vínculo a toda una sección, aplícalo a un elemento dentro de la sección.

Establece la URL del vínculo.

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL del vínculo

Volver

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

Class Body Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Métodos

Métodos obsoletos

Documentación detallada

appendHorizontalRule()

Volver

Autorización

appendImage(image)

Parámetros

Volver

Autorización

appendImage(image)

Parámetros

Volver

Autorización

appendListItem(listItem)

Parámetros

Volver

Autorización

appendListItem(text)

Parámetros

Volver

Autorización

appendPageBreak()

Volver

Autorización

appendPageBreak(pageBreak)

Parámetros

Volver

Autorización

appendParagraph(paragraph)

Parámetros

Volver

Autorización

appendParagraph(text)

Parámetros

Volver

Autorización

appendTable()

Volver

Autorización

appendTable(cells)

Parámetros

Volver

Autorización

appendTable(table)

Parámetros

Volver

Autorización

clear()

Volver

copy()

Volver

Autorización

editAsText()

Volver

findElement(elementType)

Parámetros

Volver

Autorización

findElement(elementType, from)

Parámetros

Volver

Autorización

findText(searchPattern)

Parámetros

Volver

Autorización

findText(searchPattern, from)

Parámetros

Volver

Autorización

getAttributes()

Volver

Autorización

getChild(childIndex)

Parámetros

Volver

Autorización

getChildIndex(child)

Class Body

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendPageBreak()`

`appendPageBreak(pageBreak)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getHeadingAttributes(paragraphHeading)`

`getImages()`

`getListItems()`

`getMarginBottom()`

`getMarginLeft()`

`getMarginRight()`

`getMarginTop()`

`getNumChildren()`

`getPageHeight()`

`getPageWidth()`

`getParagraphs()`

`getParent()`

`getTables()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`