Um elemento que representa uma célula de tabela. Um TableCell
está sempre contido em um TableRow
e pode conter elementos ListItem
, Paragraph
ou Table
. Para
mais informações sobre a estrutura dos documentos, consulte o guia para estender os Documentos Google.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendListItem(listItem) | ListItem | Anexa o ListItem especificado. |
appendListItem(text) | ListItem | Cria e anexa um novo ListItem . |
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph . |
appendTable() | Table | Cria e anexa um novo Table . |
appendTable(cells) | Table | Anexa um novo Table contendo as células especificadas. |
appendTable(table) | Table | Anexa o Table especificado. |
clear() | TableCell | Limpa o conteúdo do elemento. |
copy() | TableCell | 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. |
getAttributes() | Object | Recupera os atributos do elemento. |
getBackgroundColor() | String | Recupera a cor do plano de fundo. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho para o elemento filho especificado. |
getColSpan() | Integer | Recupera o período da coluna, que é o número de colunas de células da tabela que essa célula abrange. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getPaddingBottom() | Number | Recupera o padding inferior, em pontos. |
getPaddingLeft() | Number | Recupera o padding esquerdo, em pontos. |
getPaddingRight() | Number | Recupera o padding correto, em pontos. |
getPaddingTop() | Number | Recupera o padding superior, em pontos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getParentRow() | TableRow | Recupera o TableRow que contém o TableCell atual. |
getParentTable() | Table | Recupera o Table que contém o TableCell atual. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getRowSpan() | Integer | Recupera o período da linha, que é o número de linhas de células da tabela que essa célula abrange. |
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. |
getVerticalAlignment() | VerticalAlignment | Recupera o VerticalAlignment . |
getWidth() | Number | Recupera a largura da coluna que contém a célula, em pontos. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um novo HorizontalRule no índice especificado. |
insertImage(childIndex, image) | InlineImage | Cria e insere um InlineImage do blob de imagem especificado, no índice
especificado. |
insertImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Insere o ListItem especificado no índice especificado. |
insertListItem(childIndex, text) | ListItem | Cria e insere um novo ListItem no índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado. |
insertTable(childIndex) | Table | Cria e insere um novo Table no índice especificado. |
insertTable(childIndex, cells) | Table | Cria e insere um novo Table contendo as células especificadas no índice especificado. |
insertTable(childIndex, table) | Table | Insere o Table especificado no índice especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final da Document . |
merge() | TableCell | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeChild(child) | TableCell | Remove o elemento filho especificado. |
removeFromParent() | TableCell | Remove o elemento do pai. |
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. |
setAttributes(attributes) | TableCell | Define os atributos do elemento. |
setBackgroundColor(color) | TableCell | Define a cor do plano de fundo. |
setLinkUrl(url) | TableCell | Define o URL do link. |
setPaddingBottom(paddingBottom) | TableCell | Define o padding inferior, em pontos. |
setPaddingLeft(paddingLeft) | TableCell | Define o padding esquerdo, em pontos. |
setPaddingRight(paddingRight) | TableCell | Define o padding correto, em pontos. |
setPaddingTop(paddingTop) | TableCell | Define o padding superior, em pontos. |
setText(text) | TableCell | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | TableCell | Define o alinhamento do texto. |
setVerticalAlignment(alignment) | TableCell | Define o alinhamento vertical. |
setWidth(width) | TableCell | Define a largura da coluna que contém a célula atual, em pontos. |
Documentação detalhada
appendHorizontalRule()
Cria e anexa um novo HorizontalRule
.
O HorizontalRule
estará contido em um novo Paragraph
.
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
appendImage(image)
Cria e anexa um novo InlineImage
do blob de imagem especificado.
O InlineImage
estará contido em um novo Paragraph
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | BlobSource | os dados da imagem |
Retorno
InlineImage
: a nova imagem.
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
appendImage(image)
Anexa o InlineImage
especificado.
O InlineImage
estará contido em um novo Paragraph
.
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
appendListItem(listItem)
Anexa o ListItem
especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
listItem | ListItem | o item da lista a ser anexado |
Retorno
ListItem
: o item de lista 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
appendListItem(text)
Cria e anexa um novo ListItem
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o conteúdo do texto |
Retorno
ListItem
: o novo item 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
appendParagraph(paragraph)
Anexa o Paragraph
especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
paragraph | Paragraph | o parágrafo a ser anexado |
Retorno
Paragraph
: o parágrafo 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
appendParagraph(text)
Cria e anexa um novo Paragraph
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o conteúdo do texto |
Retorno
Paragraph
: o novo parágrafo
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
appendTable()
appendTable(cells)
Anexa um novo Table
contendo as células especificadas.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
cells | String[][] | o conteúdo de texto das células da tabela para adicionar à nova tabela |
Retorno
Table
: a tabela 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
appendTable(table)
Anexa o Table
especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
table | Table | da tabela a ser anexada |
Retorno
Table
: a tabela 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
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
TableCell
: 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
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
getBackgroundColor()
Recupera a cor do plano de fundo.
Retorno
String
: a cor do plano de fundo, formatada em notação CSS (como '#ffffff'
)
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
getColSpan()
Recupera o período da coluna, que é o número de colunas de células da tabela que essa célula abrange. As células não mescladas têm um espaço de colunas de 1.
Retorno
Integer
: o período da coluna, ou 0, para uma célula que foi mesclada com outra célula.
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
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
getPaddingBottom()
Recupera o padding inferior, em pontos.
Retorno
Number
: o padding da parte de baixo, 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
getPaddingLeft()
Recupera o padding esquerdo, em pontos.
Retorno
Number
: o padding esquerdo, 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
getPaddingRight()
Recupera o padding correto, em pontos.
Retorno
Number
: o padding correto, 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
getPaddingTop()
Recupera o padding superior, em pontos.
Retorno
Number
: o padding de cima, 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
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
getParentRow()
Recupera o TableRow
que contém o TableCell
atual.
Retorno
TableRow
: a linha da tabela que contém a célula 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
getParentTable()
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
getRowSpan()
Recupera o período da linha, que é o número de linhas de células da tabela que essa célula abrange. As células não mescladas têm um período de linha de 1.
Retorno
Integer
: o período das linhas, ou 0, de uma célula que foi mesclada com outra célula.
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
getVerticalAlignment()
Recupera o VerticalAlignment
.
Retorno
VerticalAlignment
: o alinhamento vertical.
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
getWidth()
Recupera a largura da coluna que contém a célula, em pontos.
Retorno
Number
: a largura da coluna, 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
insertHorizontalRule(childIndex)
Cria e insere um novo HorizontalRule
no índice especificado.
A regra horizontal será contida em um novo Paragraph
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
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
insertImage(childIndex, image)
Cria e insere um InlineImage
do blob de imagem especificado, no índice
especificado.
A imagem estará em um novo Paragraph
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
image | BlobSource | os dados da imagem |
Retorno
InlineImage
: a imagem inline inserida
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
insertImage(childIndex, image)
Insere o InlineImage
especificado no índice especificado.
A imagem estará em um novo Paragraph
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
image | InlineImage | da imagem a ser inserida |
Retorno
InlineImage
: a imagem inline inserida
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
insertListItem(childIndex, listItem)
Insere o ListItem
especificado no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
listItem | ListItem | o item da lista a ser inserido |
Retorno
ListItem
: novo item de lista 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
insertListItem(childIndex, text)
Cria e insere um novo ListItem
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
ListItem
: o novo item 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
insertParagraph(childIndex, paragraph)
Insere o Paragraph
especificado no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
paragraph | Paragraph | do parágrafo a inserir |
Retorno
Paragraph
: o parágrafo 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
insertParagraph(childIndex, text)
Cria e insere um novo Paragraph
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
Paragraph
: o novo parágrafo
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
insertTable(childIndex)
Cria e insere um novo Table
no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
Retorno
Table
: a nova tabela.
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
insertTable(childIndex, cells)
Cria e insere um novo Table
contendo as células especificadas no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir |
cells | String[][] | o conteúdo de texto das células da tabela para adicionar à nova tabela |
Retorno
Table
: a nova tabela.
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
insertTable(childIndex, table)
Insere o Table
especificado no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual inserir o elemento |
table | Table | na tabela para inserir |
Retorno
Table
: a tabela inserida.
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
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
TableCell
: 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
TableCell
: 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
TableCell
: 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
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
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
TableCell
: 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
setBackgroundColor(color)
Define a cor do plano de fundo.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | a cor de fundo, formatada em notação CSS (como '#ffffff' ) |
Retorno
TableCell
: 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
TableCell
: 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
setPaddingBottom(paddingBottom)
Define o padding inferior, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
paddingBottom | Number | o padding inferior, em pontos |
Retorno
TableCell
: 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
setPaddingLeft(paddingLeft)
Define o padding esquerdo, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
paddingLeft | Number | o padding à esquerda, em pontos |
Retorno
TableCell
: 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
setPaddingRight(paddingRight)
Define o padding correto, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
paddingRight | Number | O padding correto, em pontos. |
Retorno
TableCell
: 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
setPaddingTop(paddingTop)
Define o padding superior, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
paddingTop | Number | o padding superior, em pontos |
Retorno
TableCell
: 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 como texto simples.
Observação: o conteúdo existente é apagado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o novo conteúdo de texto |
Retorno
TableCell
: 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
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
TableCell
: 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
setVerticalAlignment(alignment)
Define o alinhamento vertical.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
alignment | VerticalAlignment | o alinhamento vertical |
Retorno
TableCell
: 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
setWidth(width)
Define a largura da coluna que contém a célula atual, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
width | Number | a largura da coluna, em pontos |
Retorno
TableCell
: 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