Se usó la API de Cloud Translation para traducir esta página.

Class Body

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

Por lo general, Body contiene el contenido completo de la pestaña, excepto los elementos HeaderSection, FooterSection y 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 muestra	Descripción breve
`appendHorizontalRule()`	`HorizontalRule`	Crea y agrega una `HorizontalRule` nueva.
`appendImage(image)`	`InlineImage`	Crea y agrega un `InlineImage` nuevo 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 una `PageBreak` nueva.
`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 una `Table` nueva.
`appendTable(cells)`	`Table`	Adjunta un `Table` nuevo 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`	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 un descendiente del tipo especificado en el contenido del elemento.
`findElement(elementType, from)`	`RangeElement`	Busca un descendiente del tipo especificado en el contenido del elemento, a partir del `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement`	Busca el patrón de texto especificado en el contenido del elemento con expresiones regulares.
`findText(searchPattern, from)`	`RangeElement`	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[]`	Recupera todos los `InlineImages` contenidos en la sección.
`getListItems()`	`ListItem[]`	Recupera todos los `ListItems` contenidos en la sección.
`getMarginBottom()`	`Number`	Recupera el margen inferior, en puntos.
`getMarginLeft()`	`Number`	Recupera el margen izquierdo, en puntos.
`getMarginRight()`	`Number`	Recupera el margen derecho.
`getMarginTop()`	`Number`	Recupera el margen superior.
`getNumChildren()`	`Integer`	Recupera la cantidad de elementos secundarios.
`getPageHeight()`	`Number`	Recupera la altura de la página, en puntos.
`getPageWidth()`	`Number`	Recupera el ancho de la página, en puntos.
`getParagraphs()`	`Paragraph[]`	Recupera todos los `Paragraphs` contenidos en la sección (incluidos `ListItems`).
`getParent()`	`ContainerElement`	Recupera el elemento superior del elemento.
`getTables()`	`Table[]`	Recupera todos los `Tables` contenidos en la sección.
`getText()`	`String`	Recupera el contenido del elemento como una cadena de texto.
`getTextAlignment()`	`TextAlignment`	Obtiene la alineación del texto.
`getType()`	`ElementType`	Recupera el `ElementType` del elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crea y, luego, inserta un `HorizontalRule` nuevo 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` determinado en el índice especificado.
`insertListItem(childIndex, listItem)`	`ListItem`	Inserta el `ListItem` determinado en el índice especificado.
`insertListItem(childIndex, text)`	`ListItem`	Crea e inserta un `ListItem` nuevo en el índice especificado, que contiene el contenido de texto especificado.
`insertPageBreak(childIndex)`	`PageBreak`	Crea y, luego, inserta un `PageBreak` nuevo en el índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Inserta el `PageBreak` determinado en el índice especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Inserta el `Paragraph` determinado en el índice especificado.
`insertParagraph(childIndex, text)`	`Paragraph`	Crea e inserta un `Paragraph` nuevo en el índice especificado, que contiene el contenido de texto especificado.
`insertTable(childIndex)`	`Table`	Crea y, luego, inserta un `Table` nuevo 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` determinado 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 con 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 muestra	Descripción breve
`getFootnotes()`	`Footnote[]`	Recupera todos los `Footnotes` contenidos en la sección.
`getLinkUrl()`	`String`	Recupera la URL del vínculo.
`getNextSibling()`	`Element`	Recupera el siguiente elemento hermano del elemento.
`getPreviousSibling()`	`Element`	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 una HorizontalRule nueva.

El HorizontalRule se contendrá en un Paragraph nuevo.

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

La imagen se contendrá en un Paragraph nuevo.

Parámetros

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

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

Parámetros

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

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 adjuntes una copia de un ListItem existente.

Parámetros

Nombre	Tipo	Descripción
`listItem`	`ListItem`	Es el elemento de la 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 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`	Es el contenido de texto del elemento de 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 ámbitos:

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

`appendPageBreak()`

Crea y agrega una PageBreak nueva.

El PageBreak se contendrá en un Paragraph nuevo.

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

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

`appendPageBreak(pageBreak)`

Agrega el PageBreak determinado.

El PageBreak se contendrá en un Paragraph nuevo.

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

Parámetros

Nombre	Tipo	Descripción
`pageBreak`	`PageBreak`	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 ámbitos:

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 adjuntes una copia de un Paragraph existente.

Parámetros

Nombre	Tipo	Descripción
`paragraph`	`Paragraph`	Es el párrafo que se agregará.

Volver

Paragraph: Es el párrafo agregado.

Autorización

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

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

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

`appendTable()`

Crea y agrega una Table nueva.

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

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

`appendTable(cells)`

Adjunta un Table nuevo 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 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.

Usa esta versión de appendTable cuando adjuntes 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`	La tabla que se anexará.

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

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

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

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

Nombre	Tipo	Descripción
`elementType`	`ElementType`	Es el tipo de elemento que se busca.
`from`	`RangeElement`	El 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

Nombre	Tipo	Descripción
`searchPattern`	`String`	el 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

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

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

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

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

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

`getImages()`

Recupera todos los InlineImages contenidos en la sección.

Volver

InlineImage[]: Son las imágenes de la sección.

Autorización

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

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

`getListItems()`

Recupera todos los ListItems contenidos en la sección.

Volver

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

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

`getMarginBottom()`

Recupera el margen inferior, en puntos.

Volver

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

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

`getMarginLeft()`

Recupera el margen izquierdo, en puntos.

Volver

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

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

`getMarginRight()`

Recupera el margen derecho.

Volver

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

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

`getMarginTop()`

Recupera el margen superior.

Volver

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

`getPageHeight()`

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

Volver

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

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

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

`getParagraphs()`

Recupera todos los Paragraphs contenidos en la sección (incluidos ListItems).

Volver

Paragraph[]: Son los párrafos de la sección.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes á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

`getTables()`

Recupera todos los Tables contenidos en la sección.

Volver

Table[]: Son las tablas de secciones.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes á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

`insertHorizontalRule(childIndex)`

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

El HorizontalRule se contendrá en un Paragraph nuevo.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Es el índice en el que se inserta el elemento.

Volver

HorizontalRule: Es la nueva regla horizontal.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes á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.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Es el índice en el que se inserta el elemento.
`image`	`BlobSource`	Los datos de la imagen.

Volver

InlineImage: Es la imagen intercalada que se insertó.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes á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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Es el índice en el que se inserta el elemento.
`image`	`InlineImage`	La imagen que se va a insertar.

Volver

InlineImage: Es la imagen intercalada que se insertó.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes á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

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

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

`insertListItem(childIndex, text)`

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

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se insertará.
`text`	`String`	Es el contenido de texto del elemento de 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 ámbitos:

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

`insertPageBreak(childIndex)`

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

El PageBreak se contendrá en un Paragraph nuevo.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Es el índice en el que se inserta 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 ámbitos:

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

`insertPageBreak(childIndex, pageBreak)`

Inserta el PageBreak determinado en el índice especificado.

El PageBreak se contendrá en un Paragraph nuevo.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	Es el índice en el que se inserta 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 á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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se insertará.
`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 ámbitos:

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

`insertParagraph(childIndex, text)`

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

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se insertará.
`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 á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

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

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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se insertará.
`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 á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

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se insertará.
`table`	`Table`	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 ámbitos:

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

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

Nombre	Tipo	Descripción
`attributes`	`Object`	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 ámbitos:

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`	Un mapa de atributos y los valores a los que se deben establecer.

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

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

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

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

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

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

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`	Es el 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 á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

Nombre	Tipo	Descripción
`text`	`String`	El nuevo contenido de texto

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

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

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 contenidos en la sección.

Volver

Footnote[]: 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 ámbitos:

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

`getLinkUrl()`

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

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()`

Obsoleto. Este elemento no tiene elementos hermanos.

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

`getPreviousSibling()`

Obsoleto. Este elemento no tiene elementos hermanos.

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

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

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

`setLinkUrl(url)`

Obsoleto. En lugar de aplicar un vínculo a una sección completa, 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 ámbitos:

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