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

Class ListItem

Elemento que representa un elemento de una lista. Un ListItem es un Paragraph que está asociado con un ID de lista. Una ListItem puede contener elementos Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak y Text. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.

ListItems no puede contener caracteres de salto de línea. Los caracteres de nueva línea ("\n") se convierten en caracteres de salto de línea ("\r").

Las ListItems con el mismo ID de lista pertenecen a la misma lista y se numeran según corresponda. No es necesario que el ListItems de una lista determinada sea adyacente en el documento ni que tenga el mismo elemento superior. Dos elementos que pertenecen a la misma lista pueden existir en cualquier parte del documento y, al mismo tiempo, mantener una numeración consecutiva, como se muestra en el siguiente ejemplo:

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

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addPositionedImage(image)`	`PositionedImage`	Crea y, luego, inserta un `PositionedImage` nuevo desde el BLOB de imágenes especificado.
`appendHorizontalRule()`	`HorizontalRule`	Crea y agrega un `HorizontalRule` nuevo.
`appendInlineImage(image)`	`InlineImage`	Crea y agrega un `InlineImage` nuevo desde el BLOB de imágenes especificado.
`appendInlineImage(image)`	`InlineImage`	Agrega el `InlineImage` determinado.
`appendPageBreak()`	`PageBreak`	Crea y agrega un `PageBreak` nuevo.
`appendPageBreak(pageBreak)`	`PageBreak`	Agrega el `PageBreak` determinado.
`appendText(text)`	`Text`	Crea y agrega un nuevo elemento `Text` con el contenido especificado.
`appendText(text)`	`Text`	Agrega el elemento `Text` determinado.
`clear()`	`ListItem`	Borra el contenido del elemento.
`copy()`	`ListItem`	Muestra una copia profunda y separada del elemento actual.
`editAsText()`	`Text`	Obtiene una versión `Text` del elemento actual para editarlo.
`findElement(elementType)`	`RangeElement`	Busca en el contenido del elemento un elemento subordinado del tipo especificado.
`findElement(elementType, from)`	`RangeElement`	Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement`	Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.
`findText(searchPattern, from)`	`RangeElement`	Busca en el contenido del elemento el patrón de texto especificado a partir de un resultado de la búsqueda determinado.
`getAlignment()`	`HorizontalAlignment`	Recupera el `HorizontalAlignment`.
`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 para el elemento secundario especificado.
`getGlyphType()`	`GlyphType`	Recupera el `GlyphType` del elemento de lista.
`getHeading()`	`ParagraphHeading`	Recupera el `ParagraphHeading`.
`getIndentEnd()`	`Number`	Recupera la sangría final, en puntos.
`getIndentFirstLine()`	`Number`	Recupera la sangría de la primera línea, en puntos.
`getIndentStart()`	`Number`	Recupera la sangría de inicio.
`getLineSpacing()`	`Number`	Recupera el interlineado, en puntos.
`getLinkUrl()`	`String`	Recupera la URL del vínculo.
`getListId()`	`String`	Recupera el ID de la lista.
`getNestingLevel()`	`Integer`	Recupera el nivel de anidamiento del elemento de lista.
`getNextSibling()`	`Element`	Recupera el siguiente elemento del mismo nivel del elemento.
`getNumChildren()`	`Integer`	Recupera la cantidad de elementos secundarios.
`getParent()`	`ContainerElement`	Recupera el elemento principal del elemento.
`getPositionedImage(id)`	`PositionedImage`	Obtiene un `PositionedImage` por el ID de la imagen.
`getPositionedImages()`	`PositionedImage[]`	Obtiene todos los objetos `PositionedImage` anclados al párrafo.
`getPreviousSibling()`	`Element`	Recupera el elemento del mismo nivel anterior del elemento.
`getSpacingAfter()`	`Number`	Recupera el espaciado después del elemento, en puntos.
`getSpacingBefore()`	`Number`	Recupera el espaciado antes del elemento, en puntos.
`getText()`	`String`	Recupera el contenido del elemento como una string de texto.
`getTextAlignment()`	`TextAlignment`	Obtiene la alineación del texto.
`getType()`	`ElementType`	Recupera el `ElementType` del elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crea y, luego, inserta un `HorizontalRule` en el índice especificado.
`insertInlineImage(childIndex, image)`	`InlineImage`	Crea y, luego, inserta un `InlineImage` nuevo desde el BLOB de imágenes especificado en el índice indicado.
`insertInlineImage(childIndex, image)`	`InlineImage`	Inserta el elemento `InlineImage` determinado en el índice especificado.
`insertPageBreak(childIndex)`	`PageBreak`	Crea y, luego, inserta un nuevo `PageBreak` en el índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Inserta el elemento `PageBreak` determinado en el índice especificado.
`insertText(childIndex, text)`	`Text`	Crea y, luego, inserta un nuevo elemento de texto en el índice especificado.
`insertText(childIndex, text)`	`Text`	Inserta el elemento `Text` dado en el índice especificado, con el contenido de texto especificado.
`isAtDocumentEnd()`	`Boolean`	Determina si el elemento se encuentra al final de `Document`.
`isLeftToRight()`	`Boolean`	Recupera la configuración de izquierda a derecha.
`merge()`	`ListItem`	Combina el elemento con el elemento del mismo nivel anterior del mismo tipo.
`removeChild(child)`	`ListItem`	Quita el elemento secundario especificado.
`removeFromParent()`	`ListItem`	Quita el elemento de su elemento superior.
`removePositionedImage(id)`	`Boolean`	Quita un `PositionedImage` por el ID de la imagen.
`replaceText(searchPattern, replacement)`	`Element`	Reemplaza todos los casos de un patrón de texto determinado por una string de reemplazo determinada mediante expresiones regulares.
`setAlignment(alignment)`	`ListItem`	Establece el `HorizontalAlignment`.
`setAttributes(attributes)`	`ListItem`	Establece los atributos del elemento.
`setGlyphType(glyphType)`	`ListItem`	Establece el `GlyphType` del elemento de lista.
`setHeading(heading)`	`ListItem`	Establece el `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`ListItem`	Establece la sangría final, en puntos.
`setIndentFirstLine(indentFirstLine)`	`ListItem`	Establece la sangría de la primera línea, en puntos.
`setIndentStart(indentStart)`	`ListItem`	Establece la sangría inicial en puntos.
`setLeftToRight(leftToRight)`	`ListItem`	Establece la configuración de izquierda a derecha.
`setLineSpacing(multiplier)`	`ListItem`	Establece el interlineado, como una cantidad que indica la cantidad de líneas que se usarán para el interlineado.
`setLinkUrl(url)`	`ListItem`	Establece la URL del vínculo.
`setListId(listItem)`	`ListItem`	Establece el ID de la lista.
`setNestingLevel(nestingLevel)`	`ListItem`	Establece el nivel de anidamiento del elemento de lista.
`setSpacingAfter(spacingAfter)`	`ListItem`	Establece el espaciado después del elemento, en puntos.
`setSpacingBefore(spacingBefore)`	`ListItem`	Establece el espaciado antes del elemento, en puntos.
`setText(text)`	`void`	Establece el contenido del elemento de la lista como texto.
`setTextAlignment(textAlignment)`	`ListItem`	Establece la alineación del texto.

Documentación detallada

`addPositionedImage(image)`

Crea y, luego, inserta un PositionedImage nuevo desde el BLOB de imágenes especificado.

Parámetros

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

Devolvedor

PositionedImage: Es la nueva imagen posicionada.

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

`appendHorizontalRule()`

Crea y agrega un HorizontalRule nuevo.

Devolvedor

HorizontalRule: Es la nueva regla horizontal.

Autorización

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

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

`appendInlineImage(image)`

Crea y agrega un InlineImage nuevo desde el BLOB de imágenes especificado.

Parámetros

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

Devolvedor

InlineImage: Es la imagen adjunta.

Autorización

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

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

`appendInlineImage(image)`

Agrega el InlineImage determinado.

Parámetros

Nombre	Tipo	Descripción
`image`	`InlineImage`	los datos de la imagen

Devolvedor

InlineImage: Es la imagen adjunta.

Autorización

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

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

`appendPageBreak()`

Crea y agrega un PageBreak nuevo.

Nota: Es posible que PageBreaks no se incluya en TableCells. Si el elemento actual está contenido en una celda de la tabla, se mostrará una excepción.

Devolvedor

PageBreak: Es el nuevo elemento de 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.

Nota: Es posible que PageBreaks no se incluya en TableCells. Si el elemento actual está contenido en una celda de la tabla, se mostrará una excepción.

Parámetros

Nombre	Tipo	Descripción
`pageBreak`	`PageBreak`	el salto de página para adjuntar

Devolvedor

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

`appendText(text)`

Crea y agrega un nuevo elemento Text con el contenido especificado.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	el contenido del texto

Devolvedor

Text: Es el nuevo elemento 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

`appendText(text)`

Agrega el elemento Text determinado.

Parámetros

Nombre	Tipo	Descripción
`text`	`Text`	el elemento de texto que se agregará

Devolvedor

Text: Es el elemento de texto adjunto.

Autorización

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

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

`clear()`

Borra el contenido del elemento.

Devolvedor

ListItem: 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 nuevo elemento no tiene un elemento superior.

Devolvedor

ListItem: Es la nueva copia.

Autorización

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

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

`editAsText()`

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

Usa editAsText para manipular el contenido de los elementos como texto enriquecido. El modo editAsText ignora los elementos que no son de texto (como InlineImage y HorizontalRule).

Los elementos secundarios completamente contenidos en un rango de texto borrado se quitan del elemento.

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Devolvedor

Text: Es una versión de texto del elemento actual.

`findElement(elementType)`

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

Parámetros

Nombre	Tipo	Descripción
`elementType`	`ElementType`	el tipo de elemento que se buscará

Devolvedor

RangeElement: Es un resultado de la búsqueda que indica la posición del elemento de búsqueda.

Autorización

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

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

`findElement(elementType, from)`

Busca en el contenido del elemento un elemento subordinado del tipo especificado a partir del RangeElement especificado.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parámetros

Nombre	Tipo	Descripción
`elementType`	`ElementType`	el tipo de elemento que se buscará
`from`	`RangeElement`	el resultado de la búsqueda desde

Devolvedor

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del elemento de búsqueda.

Autorización

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

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

`findText(searchPattern)`

Busca en el contenido del elemento el patrón de texto especificado mediante expresiones regulares.

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

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

Parámetros

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

Devolvedor

RangeElement: Es un resultado de la búsqueda que indica la posición del texto de búsqueda, o nulo si no hay una coincidencia.

Autorización

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

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

`findText(searchPattern, from)`

Busca en el contenido del elemento el patrón de texto especificado a partir de un resultado de la búsqueda determinado.

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

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

Parámetros

Nombre	Tipo	Descripción
`searchPattern`	`String`	el patrón a buscar
`from`	`RangeElement`	el resultado de la búsqueda desde

Devolvedor

RangeElement: Es un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda, o nulo si no hay una coincidencia.

Autorización

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

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

`getAlignment()`

Recupera el HorizontalAlignment.

Devolvedor

HorizontalAlignment: La alineació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

`getAttributes()`

Recupera los atributos del elemento.

El resultado es un objeto que contiene una propiedad para cada atributo de elemento válido, en el que cada nombre de propiedad corresponde a un elemento en la enumeración DocumentApp.Attribute.

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

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Devolvedor

Object: Son los atributos del elemento.

Autorización

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

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

`getChild(childIndex)`

Recupera el elemento secundario en el índice secundario especificado.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	el índice del elemento secundario para recuperar

Devolvedor

Element: Es el elemento secundario en el índice especificado.

Autorización

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

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

`getChildIndex(child)`

Recupera el índice secundario para el elemento secundario especificado.

Parámetros

Nombre	Tipo	Descripción
`child`	`Element`	el elemento secundario para el que se recupera el índice

Devolvedor

Integer: Es el índice secundario.

Autorización

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

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

`getGlyphType()`

Recupera el GlyphType del elemento de lista.

Devolvedor

GlyphType: Es el tipo de glifo.

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

`getHeading()`

Recupera el ParagraphHeading.

Devolvedor

ParagraphHeading: Es el encabezado.

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

`getIndentEnd()`

Recupera la sangría final, en puntos.

Devolvedor

Number: Es la sangría final, 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

`getIndentFirstLine()`

Recupera la sangría de la primera línea, en puntos.

Devolvedor

Number: Es la sangría de la primera línea, 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

`getIndentStart()`

Recupera la sangría de inicio.

Devolvedor

Number: Es la sangría inicial.

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

`getLineSpacing()`

Recupera el interlineado, en puntos.

Devolvedor

Number: Es el interlineado, 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

`getLinkUrl()`

Recupera la URL del vínculo.

Devolvedor

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

Autorización

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

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

`getListId()`

Recupera el ID de la lista.

Devolvedor

String: El ID 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

`getNestingLevel()`

Recupera el nivel de anidamiento del elemento de lista.

De forma predeterminada, los elementos de lista tienen un nivel de anidamiento de cero. El nivel de anidación determina el glifo que usa el elemento de la lista.

Devolvedor

Integer: Es el nivel de anidació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

`getNextSibling()`

Recupera el siguiente elemento del mismo nivel del elemento.

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

Devolvedor

Element: Es el siguiente elemento del mismo nivel.

Autorización

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

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

`getNumChildren()`

Recupera la cantidad de elementos secundarios.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Devolvedor

Integer: Es la cantidad de elementos secundarios.

Autorización

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

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

`getParent()`

Recupera el elemento principal del elemento.

El elemento superior contiene el elemento actual.

Devolvedor

ContainerElement: Es el elemento superior.

Autorización

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

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

`getPositionedImage(id)`

Obtiene un PositionedImage por el ID de la imagen.

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	el ID de la imagen

Devolvedor

PositionedImage: Es la imagen posicionada.

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

`getPositionedImages()`

Obtiene todos los objetos PositionedImage anclados al párrafo.

Devolvedor

PositionedImage[]: Es una lista de imágenes posicionadas.

Autorización

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

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

`getPreviousSibling()`

Recupera el elemento del mismo nivel anterior del elemento.

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

Devolvedor

Element: Es el elemento del mismo nivel anterior.

Autorización

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

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

`getSpacingAfter()`

Recupera el espaciado después del elemento, en puntos.

Devolvedor

Number: Es el espaciado después del elemento, 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

`getSpacingBefore()`

Recupera el espaciado antes del elemento, en puntos.

Devolvedor

Number: Es el espaciado antes del elemento, 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

`getText()`

Recupera el contenido del elemento como una string de texto.

Devolvedor

String: Es el contenido del elemento como una cadena de texto.

Autorización

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

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

`getTextAlignment()`

Obtiene la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

Devolvedor

TextAlignment: Es el tipo de alineación del texto, o null si el texto contiene varios tipos de alineaciones de texto o si nunca se estableció la alineación del texto.

Autorización

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

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

`getType()`

Recupera el ElementType del elemento.

Usa getType() para determinar el tipo exacto de un elemento determinado.

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Devolvedor

ElementType: Es el tipo de elemento.

Autorización

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

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

`insertHorizontalRule(childIndex)`

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

Parámetros

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

Devolvedor

HorizontalRule: Es el nuevo elemento de 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

`insertInlineImage(childIndex, image)`

Crea y, luego, inserta un InlineImage nuevo desde el BLOB de imágenes especificado en el índice indicado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	el índice en el que se insertará el elemento
`image`	`BlobSource`	los datos de la imagen

Devolvedor

InlineImage: Es el elemento de imagen intercalado 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

`insertInlineImage(childIndex, image)`

Inserta el elemento InlineImage determinado en el índice especificado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	el índice en el que se insertará el elemento
`image`	`InlineImage`	los datos de la imagen

Devolvedor

InlineImage: Es el elemento de imagen intercalado 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

`insertPageBreak(childIndex)`

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

Nota: Es posible que PageBreaks no se incluya en TableCells. Si el elemento actual está contenido en una celda de la tabla, se mostrará una excepción.

Parámetros

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

Devolvedor

PageBreak: Es el nuevo elemento de 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 elemento PageBreak determinado en el índice especificado.

Nota: Es posible que PageBreaks no se incluya en TableCells. Si el elemento actual está contenido en una celda de la tabla, se mostrará una excepción.

Parámetros

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

Devolvedor

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

`insertText(childIndex, text)`

Crea y, luego, inserta un nuevo elemento de texto en el índice especificado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	el índice en el que se insertará el elemento
`text`	`String`	el contenido del texto

Devolvedor

Text: Es el nuevo elemento 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

`insertText(childIndex, text)`

Inserta el elemento Text dado en el índice especificado, con el contenido de texto especificado.

Parámetros

Nombre	Tipo	Descripción
`childIndex`	`Integer`	el índice en el que se insertará el elemento
`text`	`Text`	el elemento de texto que se insertará

Devolvedor

Text: Es el elemento de texto 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

`isAtDocumentEnd()`

Determina si el elemento se encuentra al final de Document.

Devolvedor

Boolean: Indica si el elemento está al final del documento.

Autorización

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

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

`isLeftToRight()`

Recupera la configuración de izquierda a derecha.

Devolvedor

Boolean: Es la configuración de izquierda a derecha.

Autorización

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

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

`merge()`

Combina el elemento con el elemento del mismo nivel anterior del mismo tipo.

Solo se pueden combinar elementos del mismo ElementType. Todos los elementos secundarios contenidos en el elemento actual se mueven al elemento del mismo nivel anterior.

El elemento actual se quita del documento.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

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

Devolvedor

ListItem: Es el elemento combinado.

Autorización

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

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

`removeChild(child)`

Quita el elemento secundario especificado.

Parámetros

Nombre	Tipo	Descripción
`child`	`Element`	el elemento secundario quitar

Devolvedor

ListItem: Es el elemento actual.

Autorización

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

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

`removeFromParent()`

Quita el elemento de su elemento superior.

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

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Devolvedor

ListItem: Es el elemento que se quitó.

Autorización

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

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

`removePositionedImage(id)`

Quita un PositionedImage por el ID de la imagen.

Parámetros

Nombre	Tipo	Descripción
`id`	`String`

Devolvedor

Boolean: Indica si se quitó o no la imagen especificada.

Autorización

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

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

`replaceText(searchPattern, replacement)`

Reemplaza todos los casos de un patrón de texto determinado por una string de reemplazo determinada mediante expresiones regulares.

El patrón de búsqueda se pasa como una string y no como un objeto de expresión regular de JavaScript. Debido a esto, deberás escapar cualquier barra inversa en el patrón.

Este método usa la biblioteca de expresiones regulares RE2 de Google, que limita la sintaxis compatible.

El patrón de expresión regular proporcionado se compara de forma independiente con cada bloque de texto contenido en el elemento actual.

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parámetros

Nombre	Tipo	Descripción
`searchPattern`	`String`	el patrón de regex para buscar
`replacement`	`String`	el texto que se utilizará como reemplazo

Devolvedor

Element: Es el elemento actual.

Autorización

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

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

`setAlignment(alignment)`

Establece el HorizontalAlignment.

Parámetros

Nombre	Tipo	Descripción
`alignment`	`HorizontalAlignment`	la alineación horizontal

Devolvedor

ListItem: Es el elemento actual.

Autorización

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

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

`setAttributes(attributes)`

Establece los atributos del elemento.

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

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parámetros

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

Devolvedor

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

`setGlyphType(glyphType)`

Establece el GlyphType del elemento de lista.

Parámetros

Nombre	Tipo	Descripción
`glyphType`	`GlyphType`	el tipo de glifo

Devolvedor

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

`setHeading(heading)`

Establece el ParagraphHeading.

Parámetros

Nombre	Tipo	Descripción
`heading`	`ParagraphHeading`	el encabezado

Devolvedor

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

`setIndentEnd(indentEnd)`

Establece la sangría final, en puntos.

Parámetros

Nombre	Tipo	Descripción
`indentEnd`	`Number`	la sangría final, en puntos

Devolvedor

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

`setIndentFirstLine(indentFirstLine)`

Establece la sangría de la primera línea, en puntos.

Parámetros

Nombre	Tipo	Descripción
`indentFirstLine`	`Number`	la sangría de la primera línea, en puntos

Devolvedor

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

`setIndentStart(indentStart)`

Establece la sangría inicial en puntos.

Parámetros

Nombre	Tipo	Descripción
`indentStart`	`Number`	la sangría inicial, en puntos

Devolvedor

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

`setLeftToRight(leftToRight)`

Establece la configuración de izquierda a derecha.

Parámetros

Nombre	Tipo	Descripción
`leftToRight`	`Boolean`	la configuración de izquierda a derecha

Devolvedor

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

`setLineSpacing(multiplier)`

Establece el interlineado, como una cantidad que indica la cantidad de líneas que se usarán para el interlineado.

Parámetros

Nombre	Tipo	Descripción
`multiplier`	`Number`	el número de líneas

Devolvedor

ListItem: Es el elemento actual.

Autorización

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

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

`setLinkUrl(url)`

Establece la URL del vínculo.

Parámetros

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

Devolvedor

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

`setListId(listItem)`

Establece el ID de la lista.

El ID de la lista se establece con el mismo valor para el ListItem especificado. Los dos ListItems se tratarán como miembros de la misma lista.

Parámetros

Nombre	Tipo	Descripción
`listItem`	`ListItem`	el elemento de la lista cuyo ID se va a utilizar

Devolvedor

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

`setNestingLevel(nestingLevel)`

Establece el nivel de anidamiento del elemento de lista.

De forma predeterminada, los elementos de lista tienen un nivel de anidamiento de cero. El nivel de anidación determina el glifo que usa el elemento de la lista.

Parámetros

Nombre	Tipo	Descripción
`nestingLevel`	`Integer`	el nivel de anidación

Devolvedor

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

`setSpacingAfter(spacingAfter)`

Establece el espaciado después del elemento, en puntos.

Parámetros

Nombre	Tipo	Descripción
`spacingAfter`	`Number`	el espaciado después del elemento en puntos

Devolvedor

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

`setSpacingBefore(spacingBefore)`

Establece el espaciado antes del elemento, en puntos.

Parámetros

Nombre	Tipo	Descripción
`spacingBefore`	`Number`	el espaciado antes del elemento, en puntos

Devolvedor

ListItem: 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 del elemento de la lista como texto.

Nota: Se borra el contenido existente.

Parámetros

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

`setTextAlignment(textAlignment)`

Establece la alineación del texto. Los tipos de alineación disponibles son DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT y DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parámetros

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

Devolvedor

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