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

Class Body

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

En general, Body contiene el contenido completo de la pestaña, excepto los elementos HeaderSection, FooterSection y FootnoteSection.

var 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 un `HorizontalRule` nuevo.
`appendImage(image)`	`InlineImage`	Crea y agrega un `InlineImage` nuevo desde el BLOB de imagen especificado.
`appendImage(image)`	`InlineImage`	Agrega el `InlineImage` especificado.
`appendListItem(listItem)`	`ListItem`	Agrega el `ListItem` especificado.
`appendListItem(text)`	`ListItem`	Crea y agrega un `ListItem` nuevo con el contenido de texto especificado.
`appendPageBreak()`	`PageBreak`	Crea y agrega un `PageBreak` nuevo.
`appendPageBreak(pageBreak)`	`PageBreak`	Agrega el `PageBreak` especificado.
`appendParagraph(paragraph)`	`Paragraph`	Agrega el `Paragraph` especificado.
`appendParagraph(text)`	`Paragraph`	Crea y agrega un `Paragraph` nuevo con el contenido de texto especificado.
`appendTable()`	`Table`	Crea y agrega un `Table` nuevo.
`appendTable(cells)`	`Table`	Agrega un `Table` nuevo que contiene una `TableCell` para cada valor de cadena especificado.
`appendTable(table)`	`Table`	Agrega el `Table` especificado.
`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 su edición.
`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, comenzando por el especificado `RangeElement`.
`findText(searchPattern)`	`RangeElement`	Busca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.
`findText(searchPattern, from)`	`RangeElement`	Busca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.
`getAttributes()`	`Object`	Recupera los atributos del elemento.
`getChild(childIndex)`	`Element`	Recupera el elemento secundario del í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 (incluido `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 e inserta un `HorizontalRule` nuevo en el índice especificado.
`insertImage(childIndex, image)`	`InlineImage`	Crea e inserta un `InlineImage` del BLOB de imagen especificado, en el lugar especificado. índice.
`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 `ListItem` nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.
`insertPageBreak(childIndex)`	`PageBreak`	Crea e inserta un `PageBreak` nuevo 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 `Paragraph` nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.
`insertTable(childIndex)`	`Table`	Crea e inserta un `Table` nuevo en el índice especificado.
`insertTable(childIndex, cells)`	`Table`	Crea e inserta un nuevo `Table` que contenga 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 dado por una cadena de reemplazo determinada, mediante la fórmula 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`	Fija 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 elemento del mismo nivel del elemento.
`getPreviousSibling()`	`Element`	Recupera el elemento del mismo nivel anterior.
`isAtDocumentEnd()`	`Boolean`	Determina si el elemento se encuentra al final de `Document`.
`setLinkUrl(url)`	`Body`	Establece la URL del vínculo.

Documentación detallada

`appendHorizontalRule()`

Crea y agrega un HorizontalRule nuevo.

El HorizontalRule estará incluido 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 InlineImage nuevo desde el BLOB de imagen especificado.

La imagen se incluirá en un Paragraph nuevo.

Parámetros

Nombre	Tipo	Descripción
`image`	`BlobSource`	Los datos de la imagen

Volver

InlineImage: Es la imagen 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

`appendImage(image)`

Agrega el InlineImage especificado.

El InlineImage estará incluido 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`	Los datos de la imagen

Volver

InlineImage: Es la imagen 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

`appendListItem(listItem)`

Agrega el ListItem especificado.

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

Parámetros

Nombre	Tipo	Descripción
`listItem`	`ListItem`	El elemento de lista que se agregará.

Volver

ListItem: Es el elemento de lista agregado.

Autorización

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

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

`appendListItem(text)`

Crea y agrega un ListItem nuevo con el contenido de texto especificado.

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

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	El contenido de texto del elemento de lista.

Volver

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

`appendPageBreak()`

Crea y agrega un PageBreak nuevo.

El PageBreak estará incluido en un nuevo Paragraph.

Volver

PageBreak: Indica 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 especificado.

El PageBreak estará incluido 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`	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 especificado.

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

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

`appendParagraph(text)`

Crea y agrega un Paragraph nuevo con el contenido de texto especificado.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	El contenido del 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 Table nuevo.

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

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

Parámetros

Nombre	Tipo	Descripción
`cells`	`String[][]`	El contenido de texto de las celdas de la tabla que se agregarán a la tabla nueva.

Volver

Table: Es la tabla anexada.

Autorización

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

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

`appendTable(table)`

Agrega el Table especificado.

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

Parámetros

Nombre	Tipo	Descripción
`table`	`Table`	La tabla que se va a adjuntar.

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

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

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

`editAsText()`

Obtiene una versión Text del elemento actual para su edición.

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 estén completamente contenidos dentro de un rango de texto borrado se quitarán de este.

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

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 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, comenzando por el especificado RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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`	Es el resultado de 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 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 mediante expresiones regulares.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

Parámetros

Nombre	Tipo	Descripción
`searchPattern`	`String`	el patrón a buscar

Volver

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o nulo si no hay un valor. 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 el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.

Un subconjunto de las funciones de expresión regular de JavaScript no es totalmente compatible, como grupos de captura y modificadores de modo.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos 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 para buscar

Volver

RangeElement: 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 un valor. 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 el nombre de la propiedad corresponde a un elemento de la enumeración DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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]);
}

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 del índice secundario especificado.

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

// Obtain the first element in the tab.
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 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`	El elemento secundario para el que se recupera 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`	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 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 alcances:

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

`getMarginBottom()`

Recupera el margen inferior, en puntos.

Volver

Number: Indica 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: Indica 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: Indica 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: Indica 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.

var 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 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: 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 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: 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 contenidos en la sección (incluido 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 alcances:

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

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

Volver

TextAlignment: Es el tipo de alineación del texto, o null si el texto contiene varios tipos de texto. alineaciones 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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.');
}

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

El HorizontalRule estará incluido en un nuevo Paragraph.

Parámetros

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

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

`insertImage(childIndex, image)`

Crea e inserta un InlineImage del BLOB de imagen especificado, en el lugar especificado. índice.

Parámetros

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

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se inserta el elemento.
`image`	`InlineImage`	La imagen que se 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 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`	El índice en el que se realizará la inserción.
`listItem`	`ListItem`	El elemento de lista que se insertará.

Volver

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

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

`insertListItem(childIndex, text)`

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

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se realizará la inserción.
`text`	`String`	El contenido de texto del elemento de lista.

Volver

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

`insertPageBreak(childIndex)`

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

El PageBreak estará incluido en un nuevo Paragraph.

Parámetros

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

Volver

PageBreak: Indica 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 estará incluido en un nuevo Paragraph.

Parámetros

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

Volver

PageBreak: El salto de página 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 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`	El índice en el que se realizará la inserción.
`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 Paragraph nuevo que contenga el valor especificado en el índice especificado. el contenido de texto.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se realizará la inserción.
`text`	`String`	El contenido del 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 Table nuevo en el índice especificado.

Parámetros

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

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

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se realizará la inserción.
`cells`	`String[][]`	El contenido de texto de las celdas de la tabla que se agregarán a la tabla nueva.

Volver

Table: Es la tabla nueva.

Autorización

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

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

`insertTable(childIndex, table)`

Inserta el Table proporcionado en el índice especificado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	El índice en el que se realizará la inserción.
`table`	`Table`	La tabla que se insertará.

Volver

Table: Es la tabla 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 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 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 dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.

El patrón de búsqueda se pasa como una cadena, 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 el estándar RE2 de Google expresión de comandos, que limita la sintaxis compatible.

El patrón de expresión regular proporcionado se compara independientemente con cada bloque de texto. contenidos en el elemento actual.

var 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 para buscar
`replacement`	`String`	el texto que se usará como reemplazo

Volver

Element: Es el elemento actual.

Autorización

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

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

`setAttributes(attributes)`

Establece los atributos del elemento.

El parámetro de atributos especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento la enumeración DocumentApp.Attribute y el valor de cada propiedad es el nuevo que se debe se aplicó.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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.

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`	Encabezado cuyos atributos se deben establecer.
`attributes`	`Object`	Un mapa de atributos y los valores para establecerlos.

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

Fija el margen izquierdo en puntos.

Parámetros

Nombre	Tipo	Descripción
`marginLeft`	`Number`	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`	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`	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`	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 alcances:

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

`setText(text)`

Establece el contenido como texto sin formato.

Nota: Se borrará el contenido existente.

Parámetros

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 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var 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: Es el elemento actual.

Autorización

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

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

Métodos obsoletos

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

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

`getNextSibling()`

Obsoleto. Este elemento no tiene elementos del mismo nivel.

Recupera el elemento del mismo nivel del elemento.

El elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.

Volver

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

`getPreviousSibling()`

Obsoleto. Este elemento no tiene elementos del mismo nivel.

Recupera el elemento del mismo nivel anterior.

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

Volver

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

`isAtDocumentEnd()`

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

Determina si el elemento se encuentra 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: 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