Esta página foi traduzida pela API Cloud Translation.

Class TableCell

Um elemento que representa uma célula da tabela. Um TableCell está sempre contido em um TableRow e pode conter elementos ListItem, Paragraph ou Table. Para mais informações sobre a estrutura de documentos, consulte o guia para estender o Google Docs.

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` ao blob de imagem especificado.
`appendImage(image)`	`InlineImage`	Acrescenta o `InlineImage` fornecido.
`appendListItem(listItem)`	`ListItem`	Acrescenta o `ListItem` fornecido.
`appendListItem(text)`	`ListItem`	Cria e anexa um novo `ListItem`.
`appendParagraph(paragraph)`	`Paragraph`	Acrescenta o `Paragraph` fornecido.
`appendParagraph(text)`	`Paragraph`	Cria e anexa um novo `Paragraph`.
`appendTable()`	`Table`	Cria e anexa um novo `Table`.
`appendTable(cells)`	`Table`	Anexa um novo `Table` que contém as células especificadas.
`appendTable(table)`	`Table`	Acrescenta o `Table` fornecido.
`clear()`	`TableCell`	Limpa o conteúdo do elemento.
`copy()`	`TableCell`	Retorna uma cópia detalhada e separada do elemento atual.
`editAsText()`	`Text`	Recebe uma versão `Text` do elemento atual para edição.
`findElement(elementType)`	`RangeElement`	Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado.
`findElement(elementType, from)`	`RangeElement`	Pesquisa o conteúdo do elemento para encontrar 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 para encontrar o padrão de texto especificado, começando com 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 a extensão 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 crianças.
`getPaddingBottom()`	`Number`	Recupera o padding inferior, em pontos.
`getPaddingLeft()`	`Number`	Recupera o padding à esquerda, em pontos.
`getPaddingRight()`	`Number`	Recupera o padding direito, 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 a extensão 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` fornecido no índice especificado.
`insertListItem(childIndex, listItem)`	`ListItem`	Insere o `ListItem` fornecido no índice especificado.
`insertListItem(childIndex, text)`	`ListItem`	Cria e insere um novo `ListItem` no índice especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insere o `Paragraph` fornecido 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 uma nova `Table` contendo as células especificadas no índice especificado.
`insertTable(childIndex, table)`	`Table`	Insere o `Table` fornecido no índice especificado.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final da `Document`.
`merge()`	`TableCell`	Une o elemento ao elemento 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 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 à esquerda, em pontos.
`setPaddingRight(paddingRight)`	`TableCell`	Define o padding direito, 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 vai estar contido em um novo Paragraph.

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

`appendImage(image)`

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

O InlineImage vai estar contido em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`image`	`BlobSource`	os dados da imagem

Retornar

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

Acrescenta o InlineImage fornecido.

O InlineImage vai estar contido em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`image`	`InlineImage`	os 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

`appendListItem(listItem)`

Acrescenta o ListItem fornecido.

Parâmetros

Nome	Tipo	Descrição
`listItem`	`ListItem`	o item da lista a ser anexado

Retornar

ListItem: o item da 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

Retornar

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

Acrescenta o Paragraph fornecido.

Parâmetros

Nome	Tipo	Descrição
`paragraph`	`Paragraph`	o parágrafo a ser anexado

Retornar

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

Retornar

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()`

Cria e anexa um novo Table.

Retornar

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

`appendTable(cells)`

Anexa um novo Table que contém as células especificadas.

Parâmetros

Nome	Tipo	Descrição
`cells`	`String[][]`	o conteúdo de texto das células da tabela a serem adicionadas à nova tabela

Retornar

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

Acrescenta o Table fornecido.

Parâmetros

Nome	Tipo	Descrição
`table`	`Table`	a tabela a ser anexada

Retornar

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()`

Limpa o conteúdo do elemento.

Retornar

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

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()`

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

Nome	Tipo	Descrição
`elementType`	`ElementType`	O 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

Nome	Tipo	Descrição
`elementType`	`ElementType`	O tipo de elemento a ser pesquisado.
`from`	`RangeElement`	O 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

Nome	Tipo	Descrição
`searchPattern`	`String`	o 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

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão a ser pesquisado
`from`	`RangeElement`	o 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

`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

`getBackgroundColor()`

Recupera a cor do plano de fundo.

Retornar

String: a cor de plano de fundo, formatada na 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.

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

Nome	Tipo	Descrição
`childIndex`	`Integer`	O í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

Nome	Tipo	Descrição
`child`	`Element`	O 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

`getColSpan()`

Recupera a extensão 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 uma extensão de coluna de 1.

Retornar

Integer: a extensão da coluna ou 0 para uma célula mesclada a outra.

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

`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

`getPaddingBottom()`

Recupera o padding inferior, em pontos.

Retornar

Number: o padding inferior, 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 à esquerda, em pontos.

Retornar

Number: o padding à esquerda, 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 direito, em pontos.

Retornar

Number: o padding à direita, 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.

Retornar

Number: o padding superior, 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.

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

`getParentRow()`

Recupera o TableRow que contém o TableCell atual.

Retornar

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()`

Recupera o Table que contém o TableCell atual.

Retornar

Table: a 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

`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

`getRowSpan()`

Recupera a extensão 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 uma extensão de linha de 1.

Retornar

Integer: o intervalo de linhas ou 0 para uma célula mesclada a outra.

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

`getVerticalAlignment()`

Recupera o VerticalAlignment.

Retornar

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.

Retornar

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 linha horizontal vai estar contida em uma nova Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido

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

`insertImage(childIndex, image)`

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

A imagem vai estar contida em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`image`	`BlobSource`	os dados da imagem

Retornar

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 fornecido no índice especificado.

A imagem vai estar contida em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`image`	`InlineImage`	a imagem a ser inserida

Retornar

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 fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`listItem`	`ListItem`	o item da lista a ser inserido

Retornar

ListItem: 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 em que o elemento será inserido
`text`	`String`	o conteúdo do texto

Retornar

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 fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`paragraph`	`Paragraph`	o parágrafo a ser inserido

Retornar

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 em que o elemento será inserido
`text`	`String`	o conteúdo do texto

Retornar

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 em que o elemento será inserido

Retornar

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 uma nova Table contendo as células especificadas no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que inserir
`cells`	`String[][]`	o conteúdo de texto das células da tabela a serem adicionadas à nova tabela

Retornar

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 fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`table`	`Table`	a tabela a ser inserida

Retornar

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.

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

`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

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

Retornar

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.

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

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

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão de regex a ser pesquisado
`replacement`	`String`	o 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

`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

Nome	Tipo	Descrição
`attributes`	`Object`	Os atributos do elemento.

Retornar

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 plano de fundo, formatada na notação CSS (como `'#ffffff'`)

Retornar

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

Retornar

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

Retornar

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 à esquerda, em pontos.

Parâmetros

Nome	Tipo	Descrição
`paddingLeft`	`Number`	o padding à esquerda, em pontos

Retornar

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 direito, em pontos.

Parâmetros

Nome	Tipo	Descrição
`paddingRight`	`Number`	O padding à direita, em pontos.

Retornar

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

Retornar

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

Retornar

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

Nome	Tipo	Descrição
`textAlignment`	`TextAlignment`	o tipo de alinhamento de texto a ser aplicado

Retornar

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

Retornar

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

Retornar

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