Class ListItem

ListItem

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

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

Los elementos ListItems con el mismo ID de lista pertenecen a la misma lista y se numeran en consecuencia. No es necesario que los elementos ListItems de una lista determinada sean adyacentes en la pestaña ni que tengan el mismo elemento principal. Dos elementos que pertenecen a la misma lista pueden existir en cualquier parte de la pestaña y mantener la numeración consecutiva, como se ilustra en el siguiente ejemplo: 

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

// Append a new list item to the body.
const 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.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Métodos

MétodoTipo de datos que se muestraDescripción breve
addPositionedImage(image)PositionedImageCrea e inserta un nuevo PositionedImage a partir del blob de imagen especificado.
appendHorizontalRule()HorizontalRuleCrea y agrega un nuevo HorizontalRule.
appendInlineImage(image)InlineImageCrea y agrega un nuevo InlineImage a partir del blob de imagen especificado.
appendInlineImage(image)InlineImageAgrega el InlineImage determinado.
appendPageBreak()PageBreakCrea y agrega un nuevo PageBreak.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak determinado.
appendText(text)TextCrea y agrega un nuevo elemento Text con el contenido especificado.
appendText(text)TextAnexa el elemento Text determinado.
clear()ListItemBorra el contenido del elemento.
copy()ListItemDevuelve una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para editarla.
findElement(elementType)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado.
findElement(elementType, from)RangeElement|nullBusca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado.
findText(searchPattern)RangeElement|nullBusca en el contenido del elemento el patrón de texto especificado con expresiones regulares.
findText(searchPattern, from)RangeElement|nullBusca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.
getAlignment()HorizontalAlignment|nullRecupera el HorizontalAlignment.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario en el índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getGlyphType()GlyphType|nullRecupera el GlyphType del elemento de la lista.
getHeading()ParagraphHeading|nullRecupera el ParagraphHeading.
getIndentEnd()Number|nullRecupera la sangría final, en puntos.
getIndentFirstLine()Number|nullRecupera la sangría de la primera línea, en puntos.
getIndentStart()Number|nullRecupera la sangría inicial.
getLineSpacing()Number|nullRecupera el interlineado, en puntos.
getLinkUrl()String|nullRecupera la URL del vínculo.
getListId()String|nullRecupera el ID de la lista.
getNestingLevel()IntegerRecupera el nivel de anidamiento del elemento de la lista.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPositionedImage(id)PositionedImageObtiene un PositionedImage por el ID de la imagen.
getPositionedImages()PositionedImage[]Obtiene todos los objetos PositionedImage anclados al párrafo.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getSpacingAfter()Number|nullRecupera el espaciado después del elemento, en puntos.
getSpacingBefore()Number|nullRecupera el espaciado antes del elemento, en puntos.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignment|nullObtiene la alineación del texto.
getType()ElementTypeRecupera el ElementType del elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserta un HorizontalRule en el índice especificado.
insertInlineImage(childIndex, image)InlineImageCrea e inserta un nuevo InlineImage a partir del blob de imagen especificado en el índice especificado.
insertInlineImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un nuevo PageBreak en el índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInserta el PageBreak proporcionado en el índice especificado.
insertText(childIndex, text)TextCrea e inserta un nuevo elemento de texto en el índice especificado.
insertText(childIndex, text)TextInserta el elemento Text determinado en el índice especificado, con el contenido de texto especificado.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
isLeftToRight()Boolean|nullRecupera el parámetro de configuración de izquierda a derecha.
merge()ListItem|nullCombina el elemento con el hermano anterior del mismo tipo.
removeChild(child)ListItemQuita el elemento secundario especificado.
removeFromParent()ListItem|nullQuita el elemento de su elemento superior.
removePositionedImage(id)BooleanQuita un PositionedImage por el ID de la imagen.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto determinado por una cadena de reemplazo determinada, utilizando expresiones regulares.
setAlignment(alignment)ListItemEstablece el HorizontalAlignment.
setAttributes(attributes)ListItemEstablece los atributos del elemento.
setGlyphType(glyphType)ListItemEstablece el GlyphType del elemento de la lista.
setHeading(heading)ListItemEstablece el ParagraphHeading.
setIndentEnd(indentEnd)ListItemEstablece la sangría final, en puntos.
setIndentFirstLine(indentFirstLine)ListItemEstablece la sangría de la primera línea, en puntos.
setIndentStart(indentStart)ListItemEstablece la sangría inicial, en puntos.
setLeftToRight(leftToRight)ListItemEstablece el parámetro de configuración de izquierda a derecha.
setLineSpacing(multiplier)ListItemEstablece el interlineado como una cantidad que indica la cantidad de líneas que se usarán para el espaciado.
setLinkUrl(url)ListItemEstablece la URL del vínculo.
setListId(listItem)ListItemEstablece el ID de la lista.
setNestingLevel(nestingLevel)ListItemEstablece el nivel de anidamiento del elemento de la lista.
setSpacingAfter(spacingAfter)ListItemEstablece el espaciado después del elemento, en puntos.
setSpacingBefore(spacingBefore)ListItemEstablece el espaciado antes del elemento, en puntos.
setText(text)voidEstablece el contenido del elemento de lista como texto.
setTextAlignment(textAlignment)ListItemEstablece la alineación del texto.

Documentación detallada

addPositionedImage(image)

Crea e inserta un nuevo PositionedImage a partir del blob de imagen especificado.

Parámetros

NombreTipoDescripción
imageBlobSourcelos datos de la imagen

Volver

PositionedImage: 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 nuevo HorizontalRule.

Volver

HorizontalRule: 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 nuevo InlineImage a partir del blob de imagen especificado.

Parámetros

NombreTipoDescripción
imageBlobSourcelos datos de la imagen

Volver

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

NombreTipoDescripción
imageInlineImagelos datos de la imagen

Volver

InlineImage: 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 nuevo PageBreak.

Nota: PageBreaks no puede estar dentro de TableCells. Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.

Volver

PageBreak: 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: PageBreaks no puede estar dentro de TableCells. Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.

Parámetros

NombreTipoDescripción
pageBreakPageBreakSalto de página que se agregará

Volver

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

NombreTipoDescripción
textStringEl contenido del texto

Volver

Text: 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)

Anexa el elemento Text determinado.

Parámetros

NombreTipoDescripción
textTextElemento de texto que se anexará

Volver

Text: Es el elemento de texto anexado.

Autorización

Las secuencias de comandos que usan este método requieren 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

ListItem: Es el elemento actual.

copy()

Devuelve una copia profunda y separada del elemento actual.

También se copian los elementos secundarios presentes en el elemento. El nuevo elemento no tiene un elemento principal.

Volver

ListItem: Es la copia nueva.

Autorización

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

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

editAsText()

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

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

Los elementos secundarios que se encuentran completamente dentro de un rango de texto borrado se quitan del elemento. 

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

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

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

Volver

Text: Una versión de texto del elemento actual

findElement(elementType)

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

Parámetros

NombreTipoDescripción
elementTypeElementTypeEs el tipo de elemento que se buscará.

Volver

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

Autorización

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

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

findElement(elementType, from)

Busca en el contenido del elemento un elemento secundario del tipo especificado, comenzando desde el RangeElement especificado. 

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parámetros

NombreTipoDescripción
elementTypeElementTypeEs el tipo de elemento que se buscará.
fromRangeElementEs el resultado de la búsqueda desde el que se realizará la búsqueda.

Volver

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

Autorización

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

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

findText(searchPattern)

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

No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, como los grupos de captura y los modificadores de modo.

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

Parámetros

NombreTipoDescripción
searchPatternStringEl patrón que se debe buscar

Volver

RangeElement|null: Es un resultado de la búsqueda que indica la posición del texto de búsqueda o un valor nulo si no hay coincidencias.

Autorización

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

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

findText(searchPattern, from)

Busca el patrón de texto especificado en el contenido del elemento, comenzando desde un resultado de búsqueda determinado.

No se admite completamente un subconjunto de las funciones de expresiones regulares de JavaScript, como los grupos de captura y los modificadores de modo.

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

Parámetros

NombreTipoDescripción
searchPatternStringEl patrón que se debe buscar
fromRangeElementEl resultado de la búsqueda desde el que se realizará la búsqueda

Volver

RangeElement|null: Un resultado de la búsqueda que indica la siguiente posición del texto de búsqueda o un valor nulo si no hay coincidencias

Autorización

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

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

getAlignment()

Recupera el HorizontalAlignment.

Volver

HorizontalAlignment|null: 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 de la enumeración DocumentApp.Attribute. 

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Volver

Object: Son los atributos del elemento.

Autorización

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

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

getChild(childIndex)

Recupera el elemento secundario en el índice secundario especificado. 

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

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

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

Parámetros

NombreTipoDescripción
childIndexIntegerÍ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

NombreTipoDescripción
childElementElemento secundario para el que se recuperará el índice.

Volver

Integer: Es el índice secundario.

Autorización

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

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

getGlyphType()

Recupera el GlyphType del elemento de la lista.

Volver

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

Volver

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

Volver

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

Volver

Number|null: 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 inicial.

Volver

Number|null: Es la sangría de inicio.

Autorización

Las secuencias de comandos que usan este método requieren 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.

Volver

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

Volver

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

Autorización

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

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

getListId()

Recupera el ID de la lista.

Volver

String|null: Es 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 la lista.

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

Volver

Integer: El nivel de anidamiento

Autorización

Las secuencias de comandos que usan este método requieren 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 hermano del elemento.

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

Volver

Element|null: Es el siguiente elemento hermano.

Autorización

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

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

getNumChildren()

Recupera la cantidad de elementos secundarios. 

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

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Volver

Integer: Es la cantidad de hijos.

Autorización

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

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

getParent()

Recupera el elemento principal del elemento.

El elemento principal contiene el elemento actual.

Volver

ContainerElement|null: Es el elemento principal.

Autorización

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

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

getPositionedImage(id)

Obtiene un PositionedImage por el ID de la imagen.

Parámetros

NombreTipoDescripción
idStringID de la imagen

Volver

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

Volver

PositionedImage[]: 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 hermano anterior del elemento.

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

Volver

Element|null: Es el elemento hermano anterior.

Autorización

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

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

getSpacingAfter()

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

Volver

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

Volver

Number|null: Es el espacio 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 cadena de texto.

Volver

String: Contenido del elemento como cadena de texto

Autorización

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

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

getTextAlignment()

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

Volver

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

Autorización

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

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

getType()

Recupera el ElementType del elemento.

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

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

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

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

Volver

ElementType: Es el tipo de elemento.

Autorización

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

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

insertHorizontalRule(childIndex)

Crea e inserta un HorizontalRule en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento

Volver

HorizontalRule: 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 e inserta un nuevo InlineImage a partir del blob de imagen especificado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento
imageBlobSourcelos datos de la imagen

Volver

InlineImage: El elemento de imagen intercalada 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 InlineImage proporcionado en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento
imageInlineImagelos datos de la imagen

Volver

InlineImage: El elemento de imagen intercalada 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 e inserta un nuevo PageBreak en el índice especificado.

Nota: PageBreaks no puede estar dentro de TableCells. Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento

Volver

PageBreak: 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 PageBreak proporcionado en el índice especificado.

Nota: PageBreaks no puede estar dentro de TableCells. Si el elemento actual está contenido en una celda de tabla, se arrojará una excepción.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento
pageBreakPageBreakEl salto de página que se insertará

Volver

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 e inserta un nuevo elemento de texto en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento
textStringEl contenido del texto

Volver

Text: 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 determinado en el índice especificado, con el contenido de texto especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerÍndice en el que se insertará el elemento
textTextElemento de texto que se insertará

Volver

Text: 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 está al final de Document.

Volver

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

isLeftToRight()

Recupera el parámetro de configuración de izquierda a derecha.

Volver

Boolean|null: Es el parámetro de 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 hermano anterior del mismo tipo.

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

Se quita el elemento actual del documento. 

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Volver

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

NombreTipoDescripción
childElementElemento secundario que se quitará

Volver

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. 

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Volver

ListItem|null: Es el elemento quitado.

Autorización

Las secuencias de comandos que usan este método requieren 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

NombreTipoDescripción
idString

Volver

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 cadena de reemplazo determinada, utilizando expresiones regulares.

El patrón de búsqueda se pasa como una cadena, no como un objeto de expresión regular de JavaScript. Por lo tanto, deberás escapar las barras inversas en el patrón.

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

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

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

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

Parámetros

NombreTipoDescripción
searchPatternStringEl patrón de regex que se debe buscar
replacementStringEl 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

setAlignment(alignment)

Establece el HorizontalAlignment.

Parámetros

NombreTipoDescripción
alignmentHorizontalAlignmentla alineación horizontal

Volver

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 especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración DocumentApp.Attribute y cada valor de propiedad sea el nuevo valor que se aplicará. 

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

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

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

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

Parámetros

NombreTipoDescripción
attributesObjectSon los atributos del elemento.

Volver

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

Parámetros

NombreTipoDescripción
glyphTypeGlyphTypeTipo de glifo

Volver

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

NombreTipoDescripción
headingParagraphHeadingel encabezado

Volver

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

NombreTipoDescripción
indentEndNumberla sangría final, en puntos

Volver

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

NombreTipoDescripción
indentFirstLineNumberLa sangría de la primera línea, en puntos

Volver

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

NombreTipoDescripción
indentStartNumberla sangría inicial, en puntos

Volver

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 el parámetro de configuración de izquierda a derecha.

Parámetros

NombreTipoDescripción
leftToRightBooleanel parámetro de configuración de izquierda a derecha

Volver

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

Parámetros

NombreTipoDescripción
multiplierNumberLa cantidad de líneas

Volver

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

NombreTipoDescripción
urlStringLa URL del vínculo

Volver

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 en el mismo valor para el ListItem especificado. Los dos ListItems se tratarán como miembros de la misma lista.

Parámetros

NombreTipoDescripción
listItemListItemEl elemento de lista cuyo ID de lista se usará

Volver

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

De forma predeterminada, los elementos de la 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

NombreTipoDescripción
nestingLevelIntegerel nivel de anidación

Volver

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

NombreTipoDescripción
spacingAfterNumberEl espaciado después del elemento, en puntos

Volver

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

NombreTipoDescripción
spacingBeforeNumberEl espaciado antes del elemento, en puntos

Volver

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 lista como texto.

Nota: Se borrará el contenido existente.

Parámetros

NombreTipoDescripción
textStringEl contenido de texto 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

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

NombreTipoDescripción
textAlignmentTextAlignmentEl tipo de alineación de texto que se aplicará

Volver

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