Class ListItem

ListItem

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

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

ListItems con el mismo ID de lista pertenecen a la misma lista y están numeradas según corresponda. No es necesario que los elementos ListItems de una lista determinada sean adyacentes en la pestaña ni tengan el mismo elemento superior. Dos elementos que pertenecen a la misma lista pueden existir en cualquier lugar de la pestaña mientras que y mantener una numeración consecutiva, como se muestra en el siguiente ejemplo:

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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étodoTipo de datos que se muestraDescripción breve
addPositionedImage(image)PositionedImageCrea e inserta un PositionedImage nuevo desde el BLOB de imagen especificado.
appendHorizontalRule()HorizontalRuleCrea y agrega un HorizontalRule nuevo.
appendInlineImage(image)InlineImageCrea y agrega un InlineImage nuevo desde el BLOB de imagen especificado.
appendInlineImage(image)InlineImageAgrega el InlineImage especificado.
appendPageBreak()PageBreakCrea y agrega un PageBreak nuevo.
appendPageBreak(pageBreak)PageBreakAgrega el PageBreak especificado.
appendText(text)TextCrea y agrega un nuevo elemento Text con el contenido especificado.
appendText(text)TextAgrega el elemento Text especificado.
clear()ListItemBorra el contenido del elemento.
copy()ListItemMuestra una copia profunda y separada del elemento actual.
editAsText()TextObtiene una versión Text del elemento actual para su edición.
findElement(elementType)RangeElementBusca en el contenido del elemento un elemento subordinado del tipo especificado.
findElement(elementType, from)RangeElementBusca en el contenido del elemento un elemento subordinado del tipo especificado, comenzando por el especificado RangeElement.
findText(searchPattern)RangeElementBusca el patrón de texto especificado en el contenido del elemento mediante expresiones regulares.
findText(searchPattern, from)RangeElementBusca el patrón de texto especificado en el contenido del elemento, a partir de un valor determinado. resultado de la búsqueda.
getAlignment()HorizontalAlignmentRecupera el HorizontalAlignment.
getAttributes()ObjectRecupera los atributos del elemento.
getChild(childIndex)ElementRecupera el elemento secundario del índice secundario especificado.
getChildIndex(child)IntegerRecupera el índice secundario del elemento secundario especificado.
getGlyphType()GlyphTypeRecupera el GlyphType del elemento de lista.
getHeading()ParagraphHeadingRecupera el ParagraphHeading.
getIndentEnd()NumberRecupera la sangría final, en puntos.
getIndentFirstLine()NumberRecupera la sangría de la primera línea, en puntos.
getIndentStart()NumberRecupera la sangría de inicio.
getLineSpacing()NumberRecupera el interlineado, en puntos.
getLinkUrl()StringRecupera la URL del vínculo.
getListId()StringRecupera el ID de la lista.
getNestingLevel()IntegerRecupera el nivel de anidamiento del elemento de lista.
getNextSibling()ElementRecupera el elemento del mismo nivel del elemento.
getNumChildren()IntegerRecupera la cantidad de elementos secundarios.
getParent()ContainerElementRecupera el elemento superior del elemento.
getPositionedImage(id)PositionedImageObtiene un PositionedImage según el ID de la imagen.
getPositionedImages()PositionedImage[]Obtiene todos los objetos PositionedImage anclados al párrafo.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior.
getSpacingAfter()NumberRecupera el espaciado después del elemento, en puntos.
getSpacingBefore()NumberRecupera el espaciado antes del elemento, en puntos.
getText()StringRecupera el contenido del elemento como una cadena de texto.
getTextAlignment()TextAlignmentObtiene 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 InlineImage nuevo del BLOB de imagen especificado, en el lugar especificado. índice.
insertInlineImage(childIndex, image)InlineImageInserta el InlineImage proporcionado en el índice especificado.
insertPageBreak(childIndex)PageBreakCrea e inserta un PageBreak nuevo 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 texto indicado. contenidos.
isAtDocumentEnd()BooleanDetermina si el elemento se encuentra al final de Document.
isLeftToRight()BooleanRecupera la configuración de izquierda a derecha.
merge()ListItemCombina el elemento con el elemento del mismo nivel anterior del mismo tipo.
removeChild(child)ListItemQuita el elemento secundario especificado.
removeFromParent()ListItemQuita el elemento de su elemento superior.
removePositionedImage(id)BooleanQuita un PositionedImage según el ID de la imagen.
replaceText(searchPattern, replacement)ElementReemplaza todos los casos de un patrón de texto dado por una cadena de reemplazo determinada, mediante la fórmula con expresiones regulares.
setAlignment(alignment)ListItemEstablece el HorizontalAlignment.
setAttributes(attributes)ListItemEstablece los atributos del elemento.
setGlyphType(glyphType)ListItemEstablece el GlyphType del elemento de 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 de inicio en puntos.
setLeftToRight(leftToRight)ListItemEstablece la configuración de izquierda a derecha.
setLineSpacing(multiplier)ListItemEstablece el interlineado como una cantidad que indica el número de líneas que se deben utilizar para el espaciado.
setLinkUrl(url)ListItemEstablece la URL del vínculo.
setListId(listItem)ListItemEstablece el ID de lista.
setNestingLevel(nestingLevel)ListItemEstablece el nivel de anidamiento del elemento de 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 PositionedImage nuevo desde el BLOB de imagen especificado.

Parámetros

NombreTipoDescripción
imageBlobSourcelos datos de la imagen

Volver

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.

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

appendInlineImage(image)

Crea y agrega un InlineImage nuevo desde el BLOB de imagen especificado.

Parámetros

NombreTipoDescripción
imageBlobSourcelos 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

appendInlineImage(image)

Agrega el InlineImage especificado.

Parámetros

NombreTipoDescripción
imageInlineImagelos 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

appendPageBreak()

Crea y agrega un PageBreak nuevo.

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

Volver

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

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

Parámetros

NombreTipoDescripción
pageBreakPageBreakel salto de página para 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: 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 especificado.

Parámetros

NombreTipoDescripción
textTextel elemento de texto para agregar

Volver

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

clear()

Borra el contenido del elemento.

Volver

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

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

NombreTipoDescripción
elementTypeElementTypeEl 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

NombreTipoDescripción
elementTypeElementTypeEl tipo de elemento que se buscará.
fromRangeElementEs 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

NombreTipoDescripción
searchPatternStringel 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

NombreTipoDescripción
searchPatternStringel patrón a buscar
fromRangeElementel 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

getAlignment()

Recupera el HorizontalAlignment.

Volver

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

NombreTipoDescripción
childIndexIntegerEl í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
childElementEl 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

getGlyphType()

Recupera el GlyphType del elemento de lista.

Volver

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.

Volver

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.

Volver

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.

Volver

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.

Volver

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

getListId()

Recupera el ID de la lista.

Volver

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

Volver

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

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

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

getPositionedImage(id)

Obtiene un PositionedImage según el ID de la imagen.

Parámetros

NombreTipoDescripción
idStringel ID de la imagen

Volver

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.

Volver

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.

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

getSpacingAfter()

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

Volver

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.

Volver

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

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento

Volver

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 e inserta un InlineImage nuevo del BLOB de imagen especificado, en el lugar especificado. índice.

Parámetros

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

Volver

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

insertInlineImage(childIndex, image)

Inserta el InlineImage proporcionado en el índice especificado.

Parámetros

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

Volver

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

insertPageBreak(childIndex)

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

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

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento

Volver

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

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

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
pageBreakPageBreakla pausa de paginación para insertar

Volver

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

insertText(childIndex, text)

Crea e inserta un nuevo elemento de texto en el índice especificado.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
textStringel contenido del texto

Volver

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 determinado en el índice especificado, con el texto indicado. contenidos.

Parámetros

NombreTipoDescripción
childIndexIntegerel índice en el que se insertará el elemento
textTextel elemento de texto para insertar

Volver

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

isAtDocumentEnd()

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

isLeftToRight()

Recupera la configuración de izquierda a derecha.

Volver

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 de la misma ElementType. Cualquier elemento secundario que se incluya en El elemento actual se mueve al elemento del mismo nivel anterior.

Se quitará el elemento actual del documento.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

Volver

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

NombreTipoDescripción
childElementel elemento secundario para 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.

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

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

Volver

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 según 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 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

NombreTipoDescripción
searchPatternStringel patrón de regex para 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 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

NombreTipoDescripción
attributesObjectLos 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 lista.

Parámetros

NombreTipoDescripción
glyphTypeGlyphTypeel tipo 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 de inicio en puntos.

Parámetros

NombreTipoDescripción
indentStartNumberla sangría de inicio, 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 la configuración de izquierda a derecha.

Parámetros

NombreTipoDescripción
leftToRightBooleanla 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 el número de líneas que se deben utilizar para el espaciado.

Parámetros

NombreTipoDescripción
multiplierNumberel número 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 lista.

El ID de la lista tiene el mismo valor para el ListItem especificado. Los dos ListItems se considerarán miembros de la misma lista.

Parámetros

NombreTipoDescripción
listItemListItemel elemento de la lista cuyo ID 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 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

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

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