Elemento que representa um item da 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 dos documentos, consulte o guia para estender os Documentos Google.
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").
As ListItems
com o mesmo ID pertencem à mesma lista e são numeradas.
As ListItems
de uma determinada lista não precisam ser adjacentes ao documento nem ter
o mesmo elemento pai. Dois itens que pertencem à mesma lista podem existir em qualquer lugar do documento, mantendo a numeração consecutiva, como ilustra o exemplo a seguir:
var body = DocumentApp.getActiveDocument().getBody(); // Append a new list item to the body. var item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([ ['Cell 1', 'Cell 2'] ]); // Append a second list item with the same list ID. The two items are treated as the same list, // despite not being consecutive. var item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addPositionedImage(image) | PositionedImage | Cria e insere um novo PositionedImage do blob de imagem especificado. |
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendInlineImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendInlineImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendPageBreak() | PageBreak | Cria e anexa um novo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Anexa o PageBreak especificado. |
appendText(text) | Text | Cria e anexa um novo elemento Text com o conteúdo especificado. |
appendText(text) | Text | Anexa o elemento Text especificado. |
clear() | ListItem | Limpa o conteúdo do elemento. |
copy() | ListItem | Retorna uma cópia profunda desanexada do elemento atual. |
editAsText() | Text | Extrai uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAlignment() | HorizontalAlignment | Recupera o HorizontalAlignment . |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho para o elemento filho especificado. |
getGlyphType() | GlyphType | Recupera o GlyphType do item da lista. |
getHeading() | ParagraphHeading | Recupera o ParagraphHeading . |
getIndentEnd() | Number | Recupera o recuo final, em pontos. |
getIndentFirstLine() | Number | Recupera o recuo da primeira linha, em pontos. |
getIndentStart() | Number | Recupera o recuo inicial. |
getLineSpacing() | Number | Recupera o espaçamento entre linhas, em pontos. |
getLinkUrl() | String | Recupera o URL do link. |
getListId() | String | Recupera o ID da lista. |
getNestingLevel() | Integer | Recupera o nível de aninhamento do item da lista. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPositionedImage(id) | PositionedImage | Recebe um PositionedImage pelo ID da imagem. |
getPositionedImages() | PositionedImage[] | Recebe todos os objetos PositionedImage ancorados ao parágrafo. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getSpacingAfter() | Number | Recupera o espaçamento depois do elemento, em pontos. |
getSpacingBefore() | Number | Recupera o espaçamento antes do elemento, em pontos. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Recebe o alinhamento do texto. |
getType() | ElementType | Recupera o ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um HorizontalRule no índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Cria e insere um novo InlineImage do blob de imagem especificado, no índice
especificado. |
insertInlineImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertPageBreak(childIndex) | PageBreak | Cria e insere um novo PageBreak no índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insere o PageBreak especificado no índice especificado. |
insertText(childIndex, text) | Text | Cria e insere um novo elemento de texto no índice especificado. |
insertText(childIndex, text) | Text | Insere o elemento Text especificado no índice especificado, com o conteúdo de texto especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final da Document . |
isLeftToRight() | Boolean | Recupera a configuração da esquerda para a direita. |
merge() | ListItem | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeChild(child) | ListItem | Remove o elemento filho especificado. |
removeFromParent() | ListItem | Remove o elemento do pai. |
removePositionedImage(id) | Boolean | Remove um PositionedImage pelo ID da imagem. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição especificada, usando expressões regulares. |
setAlignment(alignment) | ListItem | Define o HorizontalAlignment . |
setAttributes(attributes) | ListItem | Define os atributos do elemento. |
setGlyphType(glyphType) | ListItem | Define o GlyphType do item da lista. |
setHeading(heading) | ListItem | Define o ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Define o recuo final, em pontos. |
setIndentFirstLine(indentFirstLine) | ListItem | Define o recuo da primeira linha, em pontos. |
setIndentStart(indentStart) | ListItem | Define o recuo inicial, em pontos. |
setLeftToRight(leftToRight) | ListItem | Define a configuração da esquerda para a direita. |
setLineSpacing(multiplier) | ListItem | Define o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para o espaçamento. |
setLinkUrl(url) | ListItem | Define o URL do link. |
setListId(listItem) | ListItem | Define o ID da lista. |
setNestingLevel(nestingLevel) | ListItem | Define o nível de aninhamento do item da lista. |
setSpacingAfter(spacingAfter) | ListItem | Define o espaçamento depois do elemento, em pontos. |
setSpacingBefore(spacingBefore) | ListItem | Define o espaçamento antes do elemento, em pontos. |
setText(text) | void | Define o conteúdo do item da lista como texto. |
setTextAlignment(textAlignment) | ListItem | Define o alinhamento do texto. |
Documentação detalhada
addPositionedImage(image)
Cria e insere um novo PositionedImage
do blob de imagem especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | BlobSource | os dados da imagem |
Retorno
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
.
Retorno
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
do blob de imagem especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | BlobSource | os dados da imagem |
Retorno
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)
Anexa o InlineImage
especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | InlineImage | os dados da imagem |
Retorno
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
pode não estar contido em TableCells
.
Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.
Retorno
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)
Anexa o PageBreak
especificado.
Observação: PageBreaks
pode não estar contido em TableCells
.
Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
pageBreak | PageBreak | a quebra de página a ser anexada |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
text | String | o conteúdo do texto |
Retorno
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)
Anexa o elemento Text
especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | o elemento de texto a ser anexado |
Retorno
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()
copy()
Retorna uma cópia profunda desanexada do elemento atual.
Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um pai.
Retorno
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()
Extrai 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
).
Elementos filho totalmente contidos em um intervalo de texto excluído são removidos do elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Retorno
Text
: uma versão em texto do elemento atual.
findElement(elementType)
Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
elementType | ElementType | o tipo de elemento a ser pesquisado |
Retorno
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 em busca de um descendente do tipo especificado, começando pelo
RangeElement
especificado.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
elementType | ElementType | o tipo de elemento a ser pesquisado |
from | RangeElement | o resultado da pesquisa para pesquisar |
Retorno
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 JavaScript não tem suporte total, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido é correspondido de maneira independente a cada bloco de texto contido no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
Retorno
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 em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
Um subconjunto dos recursos de expressão regular JavaScript não tem suporte total, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido é correspondido de maneira independente a cada bloco de texto contido no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
from | RangeElement | o resultado da pesquisa para pesquisar |
Retorno
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
.
Retorno
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
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Retorno
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.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice do elemento filho a ser recuperado |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
child | Element | o elemento filho para o qual recuperar o índice |
Retorno
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()
getHeading()
Recupera o ParagraphHeading
.
Retorno
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 o recuo final, em pontos.
Retorno
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.
Retorno
Number
: o 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.
Retorno
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.
Retorno
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.
Retorno
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.
Retorno
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 zero. O nível de aninhamento determina o glifo usado pelo item da lista.
Retorno
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.
Retorno
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 filhos.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Retorno
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.
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da imagem |
Retorno
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.
Retorno
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 antecede o elemento atual.
Retorno
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 depois do elemento, em pontos.
Retorno
Number
: o espaçamento depois 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
getSpacingBefore()
Recupera o espaçamento antes do elemento, em pontos.
Retorno
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.
Retorno
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
.
Retorno
TextAlignment
: o tipo de alinhamento do texto, ou null
se o texto contiver vários tipos de alinhamento ou se o alinhamento nunca tiver sido 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.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
image | BlobSource | os dados da imagem |
Retorno
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
especificado no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
image | InlineImage | os dados da imagem |
Retorno
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
pode não estar contido em TableCells
.
Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
Retorno
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
especificado no índice especificado.
Observação: PageBreaks
pode não estar contido em TableCells
.
Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
pageBreak | PageBreak | a quebra de página para inserir |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
text | String | o conteúdo do texto |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
text | Text | o elemento de texto a ser inserido |
Retorno
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
.
Retorno
Boolean
: se o elemento está no final do documento.
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.
Retorno
Boolean
: 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()
Mescla o elemento com o 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.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
child | Element | o elemento filho a ser removido |
Retorno
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.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
id | String |
Retorno
Boolean
: 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 especificada, usando expressões regulares.
O padrão de pesquisa é transmitido como uma string, e não um objeto de expressão regular JavaScript. Por isso, você precisa evitar barras invertidas no padrão.
Esse método usa a biblioteca de expressões regulares RE2 do Google, que limita a sintaxe compatível.
O padrão de expressão regular fornecido é correspondido de maneira independente a cada bloco de texto contido no elemento atual.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão de regex a ser pesquisado |
replacement | String | o texto a ser usado como substituto |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
alignment | HorizontalAlignment | o alinhamento horizontal |
Retorno
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 especificados precisa ser um objeto em que cada nome de propriedade é um item na
enumeração de DocumentApp.Attribute
e cada valor de propriedade é o novo valor a ser
aplicado.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
attributes | Object | Os atributos do elemento. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
glyphType | GlyphType | o tipo de glifo |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
heading | ParagraphHeading | o título |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
indentEnd | Number | o recuo final, em pontos |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
indentFirstLine | Number | o recuo da primeira linha, em pontos |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
indentStart | Number | o recuo inicial, em pontos |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
leftToRight | Boolean | a configuração da esquerda para a direita |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
multiplier | Number | o número de linhas |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
url | String | o URL do link |
Retorno
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 está definido como o mesmo valor para o ListItem
especificado. Os dois ListItems
serão tratados como membros da mesma lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
listItem | ListItem | o item da lista cujo ID de lista será usado |
Retorno
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 zero. O nível de aninhamento determina o glifo usado pelo item da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
nestingLevel | Integer | o nível de aninhamento |
Retorno
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 depois do elemento, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
spacingAfter | Number | o espaçamento após o elemento, em pontos |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
spacingBefore | Number | o espaçamento antes do elemento, em pontos |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
text | String | o 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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
textAlignment | TextAlignment | o tipo de alinhamento de texto a ser aplicado |
Retorno
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