Class ListItem

ListItem

Um elemento que representa um item de lista. Um ListItem é um Paragraph associado a um ID de lista. Um ListItem pode conter elementos Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak e Text. Para mais informações sobre a estrutura do documento, consulte o guia para estender o Google Docs.

ListItems não pode conter caracteres de nova linha. Os caracteres de nova linha ("\n") são convertidos em caracteres de quebra de linha ("\r").

ListItemss com o mesmo ID de lista pertencem à mesma lista e são numerados de acordo. Os ListItems de uma determinada lista não precisam estar adjacentes na guia ou ter o mesmo elemento pai. Dois itens que pertencem à mesma lista podem existir em qualquer lugar da guia, mantendo a numeração consecutiva, conforme ilustrado no exemplo a seguir:

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 retornoBreve descrição
addPositionedImage(image)PositionedImageCria e insere um novo PositionedImage do blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa um novo InlineImage ao blob de imagem especificado.
appendInlineImage(image)InlineImageAcrescenta o InlineImage fornecido.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAcrescenta o PageBreak fornecido.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAnexar o elemento Text fornecido.
clear()ListItemLimpa o conteúdo do elemento.
copy()ListItemRetorna uma cópia detalhada e separada do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAlignment()HorizontalAlignmentRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho para o elemento filho especificado.
getGlyphType()GlyphTypeRecupera o GlyphType do item da lista.
getHeading()ParagraphHeadingRecupera o ParagraphHeading.
getIndentEnd()NumberRecupera a indentação final, em pontos.
getIndentFirstLine()NumberRecupera o recuo da primeira linha, em pontos.
getIndentStart()NumberRecupera o recuo inicial.
getLineSpacing()NumberRecupera o espaçamento entre linhas, em pontos.
getLinkUrl()StringRecupera o URL do link.
getListId()StringRecupera o ID da lista.
getNestingLevel()IntegerRecupera o nível de aninhamento do item da lista.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de crianças.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Recebe todos os objetos PositionedImage ancorados ao parágrafo.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getSpacingAfter()NumberRecupera o espaçamento após o elemento, em pontos.
getSpacingBefore()NumberRecupera o espaçamento antes do elemento, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um HorizontalRule no índice especificado.
insertInlineImage(childIndex, image)InlineImageCria e insere um novo InlineImage do blob de imagem especificado no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage fornecido no índice especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak fornecido no índice especificado.
insertText(childIndex, text)TextCria e insere um novo elemento de texto no índice especificado.
insertText(childIndex, text)TextInsere o elemento Text especificado no índice especificado, com o conteúdo de texto especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final da Document.
isLeftToRight()BooleanRecupera a configuração da esquerda para a direita.
merge()ListItemUne o elemento ao elemento irmão anterior do mesmo tipo.
removeChild(child)ListItemRemove o elemento filho especificado.
removeFromParent()ListItemRemove o elemento do pai.
removePositionedImage(id)BooleanRemove um PositionedImage pelo ID da imagem.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma string de substituição usando expressões regulares.
setAlignment(alignment)ListItemDefine o HorizontalAlignment.
setAttributes(attributes)ListItemDefine os atributos do elemento.
setGlyphType(glyphType)ListItemDefine o GlyphType do item da lista.
setHeading(heading)ListItemDefine o ParagraphHeading.
setIndentEnd(indentEnd)ListItemDefine o recuo final, em pontos.
setIndentFirstLine(indentFirstLine)ListItemDefine o recuo da primeira linha, em pontos.
setIndentStart(indentStart)ListItemDefine o recuo inicial, em pontos.
setLeftToRight(leftToRight)ListItemDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ListItemDefine o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para o espaçamento.
setLinkUrl(url)ListItemDefine o URL do link.
setListId(listItem)ListItemDefine o ID da lista.
setNestingLevel(nestingLevel)ListItemDefine o nível de aninhamento do item da lista.
setSpacingAfter(spacingAfter)ListItemDefine o espaçamento após o elemento, em pontos.
setSpacingBefore(spacingBefore)ListItemDefine o espaçamento antes do elemento, em pontos.
setText(text)voidDefine o conteúdo do item da lista como texto.
setTextAlignment(textAlignment)ListItemDefine o alinhamento do texto.

Documentação detalhada

addPositionedImage(image)

Cria e insere um novo PositionedImage do blob de imagem especificado.

Parâmetros

NomeTipoDescrição
imageBlobSourceos dados da imagem

Retornar

PositionedImage: a nova imagem posicionada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendHorizontalRule()

Cria e anexa um novo HorizontalRule.

Retornar

HorizontalRule: a nova regra horizontal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendInlineImage(image)

Cria e anexa um novo InlineImage ao blob de imagem especificado.

Parâmetros

NomeTipoDescrição
imageBlobSourceos dados da imagem

Retornar

InlineImage: a imagem anexada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendInlineImage(image)

Acrescenta o InlineImage fornecido.

Parâmetros

NomeTipoDescrição
imageInlineImageos dados da imagem

Retornar

InlineImage: a imagem anexada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendPageBreak()

Cria e anexa um novo PageBreak.

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula de tabela, uma exceção será gerada.

Retornar

PageBreak: o novo elemento de quebra de página

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendPageBreak(pageBreak)

Acrescenta o PageBreak fornecido.

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula de tabela, uma exceção será gerada.

Parâmetros

NomeTipoDescrição
pageBreakPageBreaka quebra de página a ser anexada

Retornar

PageBreak: o elemento de quebra de página anexado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendText(text)

Cria e anexa um novo elemento Text com o conteúdo especificado.

Parâmetros

NomeTipoDescrição
textStringo conteúdo do texto

Retornar

Text: o novo elemento de texto

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendText(text)

Anexar o elemento Text fornecido.

Parâmetros

NomeTipoDescrição
textTexto elemento de texto a ser anexado

Retornar

Text: o elemento de texto anexado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

clear()

Limpa o conteúdo do elemento.

Retornar

ListItem: o elemento atual.


copy()

Retorna uma cópia detalhada e separada do elemento atual.

Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um elemento pai.

Retornar

ListItem: a nova cópia.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

editAsText()

Recebe uma versão Text do elemento atual para edição.

Use editAsText para manipular o conteúdo dos elementos como rich text. O modo editAsText ignora elementos não textuais, como InlineImage e HorizontalRule.

Os elementos filhos totalmente contidos em um intervalo de texto excluído são removidos do 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);

Retornar

Text: uma versão de texto do elemento atual


findElement(elementType)

Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado.

Parâmetros

NomeTipoDescrição
elementTypeElementTypeO tipo de elemento a ser pesquisado.

Retornar

RangeElement: um resultado da pesquisa que indica a posição do elemento de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

findElement(elementType, from)

Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo 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

NomeTipoDescrição
elementTypeElementTypeO tipo de elemento a ser pesquisado.
fromRangeElementO resultado da pesquisa a ser usado.

Retornar

RangeElement: um resultado da pesquisa que indica a próxima posição do elemento de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

findText(searchPattern)

Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.

Um subconjunto dos recursos de expressão regular do JavaScript não tem suporte total, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido é correspondido de forma independente a cada bloco de texto contido no elemento atual.

Parâmetros

NomeTipoDescrição
searchPatternStringo padrão a ser pesquisado

Retornar

RangeElement: um resultado da pesquisa que indica a posição do texto da pesquisa ou nulo se não houver correspondência.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

findText(searchPattern, from)

Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado, começando com um determinado resultado da pesquisa.

Um subconjunto dos recursos de expressão regular do JavaScript não tem suporte total, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido é correspondido de forma independente a cada bloco de texto contido no elemento atual.

Parâmetros

NomeTipoDescrição
searchPatternStringo padrão a ser pesquisado
fromRangeElemento resultado da pesquisa a ser usado

Retornar

RangeElement: um resultado da pesquisa que indica a próxima posição do texto da pesquisa ou nulo se não houver correspondência

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAlignment()

Recupera o HorizontalAlignment.

Retornar

HorizontalAlignment: o alinhamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAttributes()

Recupera os atributos do elemento.

O resultado é um objeto que contém uma propriedade para cada atributo de elemento válido, em que cada nome de propriedade corresponde a um item na enumeração 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]}`);
}

Retornar

Object: os atributos do elemento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getChild(childIndex)

Recupera o elemento filho no índice filho 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

NomeTipoDescrição
childIndexIntegerO índice do elemento filho a ser recuperado.

Retornar

Element: o elemento filho no índice especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getChildIndex(child)

Recupera o índice filho para o elemento filho especificado.

Parâmetros

NomeTipoDescrição
childElementO elemento filho para o qual o índice será recuperado.

Retornar

Integer: o índice filho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getGlyphType()

Recupera o GlyphType do item da lista.

Retornar

GlyphType: o tipo de glifo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getHeading()

Recupera o ParagraphHeading.

Retornar

ParagraphHeading: o título

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getIndentEnd()

Recupera a indentação final, em pontos.

Retornar

Number: o recuo final, em pontos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getIndentFirstLine()

Recupera o recuo da primeira linha, em pontos.

Retornar

Number: recuo da primeira linha, em pontos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getIndentStart()

Recupera o recuo inicial.

Retornar

Number: o recuo inicial

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getLineSpacing()

Recupera o espaçamento entre linhas, em pontos.

Retornar

Number: o espaçamento entre linhas, em pontos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getLinkUrl()

Recupera o URL do link.

Retornar

String: o URL do link ou nulo se o elemento tiver vários valores para esse atributo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getListId()

Recupera o ID da lista.

Retornar

String: o ID da lista

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getNestingLevel()

Recupera o nível de aninhamento do item da lista.

Por padrão, os itens da lista têm um nível de aninhamento de zero. O nível de aninhamento determina o glifo usado pelo item da lista.

Retornar

Integer: o nível de aninhamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getNextSibling()

Recupera o próximo elemento irmão do elemento.

O próximo irmão tem o mesmo pai e segue o elemento atual.

Retornar

Element: o próximo elemento irmão.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getNumChildren()

Recupera o número de crianças.

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

Retornar

Integer: o número de filhos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getParent()

Recupera o elemento pai do elemento.

O elemento pai contém o elemento atual.

Retornar

ContainerElement: o elemento pai.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getPositionedImage(id)

Recebe um PositionedImage pelo ID da imagem.

Parâmetros

NomeTipoDescrição
idStringo ID da imagem

Retornar

PositionedImage: a imagem posicionada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getPositionedImages()

Recebe todos os objetos PositionedImage ancorados ao parágrafo.

Retornar

PositionedImage[]: uma lista de imagens posicionadas

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getPreviousSibling()

Recupera o elemento irmão anterior do elemento.

O irmão anterior tem o mesmo pai e precede o elemento atual.

Retornar

Element: o elemento irmão anterior.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getSpacingAfter()

Recupera o espaçamento após o elemento, em pontos.

Retornar

Number: o espaçamento após o elemento, em pontos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getSpacingBefore()

Recupera o espaçamento antes do elemento, em pontos.

Retornar

Number: o espaçamento antes do elemento, em pontos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getText()

Recupera o conteúdo do elemento como uma string de texto.

Retornar

String: o conteúdo do elemento como string de texto

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTextAlignment()

Recebe o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

Retornar

TextAlignment: o tipo de alinhamento do texto ou null se o texto contém vários tipos de alinhamento ou se o alinhamento nunca foi definido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getType()

Recupera o ElementType do elemento.

Use getType() para determinar o tipo exato de um determinado elemento.

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.');
}

Retornar

ElementType: o tipo de elemento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertHorizontalRule(childIndex)

Cria e insere um HorizontalRule no índice especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido

Retornar

HorizontalRule: o novo elemento de regra horizontal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertInlineImage(childIndex, image)

Cria e insere um novo InlineImage do blob de imagem especificado no índice especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido
imageBlobSourceos dados da imagem

Retornar

InlineImage: o elemento de imagem inline inserido

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertInlineImage(childIndex, image)

Insere o InlineImage fornecido no índice especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido
imageInlineImageos dados da imagem

Retornar

InlineImage: o elemento de imagem inline inserido

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertPageBreak(childIndex)

Cria e insere um novo PageBreak no índice especificado.

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula de tabela, uma exceção será gerada.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido

Retornar

PageBreak: o novo elemento de quebra de página

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertPageBreak(childIndex, pageBreak)

Insere o PageBreak fornecido no índice especificado.

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula de tabela, uma exceção será gerada.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido
pageBreakPageBreaka quebra de página a ser inserida

Retornar

PageBreak: o elemento de quebra de página inserido

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertText(childIndex, text)

Cria e insere um novo elemento de texto no índice especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido
textStringo conteúdo do texto

Retornar

Text: o novo elemento de texto

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertText(childIndex, text)

Insere o elemento Text especificado no índice especificado, com o conteúdo de texto especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice em que o elemento será inserido
textTexto elemento de texto a ser inserido

Retornar

Text: o elemento de texto inserido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isAtDocumentEnd()

Determina se o elemento está no final da Document.

Retornar

Boolean: se o elemento está no final da guia.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isLeftToRight()

Recupera a configuração da esquerda para a direita.

Retornar

Boolean: a configuração da esquerda para a direita

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

merge()

Une o elemento ao elemento irmão anterior do mesmo tipo.

Só é possível mesclar elementos do mesmo ElementType. Todos os elementos filhos contidos no elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do 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();

Retornar

ListItem: o elemento mesclado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

removeChild(child)

Remove o elemento filho especificado.

Parâmetros

NomeTipoDescrição
childElemento elemento filho a ser removido

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

removeFromParent()

Remove o elemento do pai.

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();
}

Retornar

ListItem: o elemento removido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

removePositionedImage(id)

Remove um PositionedImage pelo ID da imagem.

Parâmetros

NomeTipoDescrição
idString

Retornar

Boolean: indica se a imagem especificada foi removida ou não

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

replaceText(searchPattern, replacement)

Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição usando expressões regulares.

O padrão de pesquisa é transmitido como uma string, não como um objeto de expressão regular do JavaScript. Por isso, é necessário inserir barras invertidas no padrão.

Esse método usa a biblioteca de expressões regulares RE2 do Google, que limita a sintaxe com suporte.

O padrão de expressão regular fornecido é correspondido de forma independente a cada bloco de texto contido no elemento atual.

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

NomeTipoDescrição
searchPatternStringo padrão de regex a ser pesquisado
replacementStringo texto a ser usado como substituição

Retornar

Element: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setAlignment(alignment)

Define o HorizontalAlignment.

Parâmetros

NomeTipoDescrição
alignmentHorizontalAlignmento alinhamento horizontal

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setAttributes(attributes)

Define os atributos do elemento.

O parâmetro de atributos especificado precisa ser um objeto em que cada nome de propriedade seja um item na enumeração DocumentApp.Attribute e cada valor de propriedade seja o novo valor a ser aplicado.

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

NomeTipoDescrição
attributesObjectOs atributos do elemento.

Retornar

ListItem: o elemento atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setGlyphType(glyphType)

Define o GlyphType do item da lista.

Parâmetros

NomeTipoDescrição
glyphTypeGlyphTypeo tipo de glifo

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setHeading(heading)

Define o ParagraphHeading.

Parâmetros

NomeTipoDescrição
headingParagraphHeadingo título

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setIndentEnd(indentEnd)

Define o recuo final, em pontos.

Parâmetros

NomeTipoDescrição
indentEndNumbero recuo final, em pontos

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setIndentFirstLine(indentFirstLine)

Define o recuo da primeira linha, em pontos.

Parâmetros

NomeTipoDescrição
indentFirstLineNumbero recuo da primeira linha, em pontos

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setIndentStart(indentStart)

Define o recuo inicial, em pontos.

Parâmetros

NomeTipoDescrição
indentStartNumbero recuo inicial, em pontos

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setLeftToRight(leftToRight)

Define a configuração da esquerda para a direita.

Parâmetros

NomeTipoDescrição
leftToRightBooleana configuração da esquerda para a direita

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setLineSpacing(multiplier)

Define o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para o espaçamento.

Parâmetros

NomeTipoDescrição
multiplierNumbero número de linhas

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setLinkUrl(url)

Define o URL do link.

Parâmetros

NomeTipoDescrição
urlStringo URL do link

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setListId(listItem)

Define o ID da lista.

O ID da lista é definido como o mesmo valor para o ListItem especificado. Os dois ListItems serão tratados como membros da mesma lista.

Parâmetros

NomeTipoDescrição
listItemListItemO item de lista cujo ID de lista será usado

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setNestingLevel(nestingLevel)

Define o nível de aninhamento do item da lista.

Por padrão, os itens da lista têm um nível de aninhamento de zero. O nível de aninhamento determina o glifo usado pelo item da lista.

Parâmetros

NomeTipoDescrição
nestingLevelIntegero nível de aninhamento

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setSpacingAfter(spacingAfter)

Define o espaçamento após o elemento, em pontos.

Parâmetros

NomeTipoDescrição
spacingAfterNumbero espaçamento após o elemento, em pontos

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setSpacingBefore(spacingBefore)

Define o espaçamento antes do elemento, em pontos.

Parâmetros

NomeTipoDescrição
spacingBeforeNumbero espaçamento antes do elemento, em pontos

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setText(text)

Define o conteúdo do item da lista como texto.

Observação: o conteúdo existente é apagado.

Parâmetros

NomeTipoDescrição
textStringo novo conteúdo de texto

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setTextAlignment(textAlignment)

Define o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e 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

NomeTipoDescrição
textAlignmentTextAlignmento tipo de alinhamento de texto a ser aplicado

Retornar

ListItem: o elemento atual

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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