Esta página foi traduzida pela API Cloud Translation.

Class TableCell

Um elemento que representa uma célula de tabela. Um TableCell sempre está contido em um TableRow e pode conter elementos ListItem, Paragraph ou Table. Para mais informações sobre a estrutura do documento, 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` do blob de imagem especificado.
`appendImage(image)`	`InlineImage`	Acrescenta o `InlineImage` especificado.
`appendListItem(listItem)`	`ListItem`	Acrescenta o `ListItem` especificado.
`appendListItem(text)`	`ListItem`	Cria e anexa um novo `ListItem`.
`appendParagraph(paragraph)`	`Paragraph`	Acrescenta o `Paragraph` especificado.
`appendParagraph(text)`	`Paragraph`	Cria e anexa um novo `Paragraph`.
`appendTable()`	`Table`	Cria e anexa um novo `Table`.
`appendTable(cells)`	`Table`	Adiciona um novo `Table` que contém as células especificadas.
`appendTable(table)`	`Table`	Acrescenta o `Table` especificado.
`clear()`	`TableCell`	Limpa o conteúdo do elemento.
`copy()`	`TableCell`	Retorna uma cópia detalhada e independente do elemento atual.
`editAsText()`	`Text`	Recebe uma versão `Text` do elemento atual para edição.
`findElement(elementType)`	`RangeElement\|null`	Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
`findElement(elementType, from)`	`RangeElement\|null`	Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement\|null`	Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
`findText(searchPattern, from)`	`RangeElement\|null`	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\|null`	Recupera a cor de plano de fundo.
`getChild(childIndex)`	`Element`	Recupera o elemento filho no índice especificado.
`getChildIndex(child)`	`Integer`	Recupera o índice filho do elemento filho especificado.
`getColSpan()`	`Integer`	Recupera o intervalo de colunas, que é o número de colunas de células da tabela que esta célula abrange.
`getLinkUrl()`	`String\|null`	Recupera o URL do link.
`getNextSibling()`	`Element\|null`	Recupera o próximo elemento irmão do elemento.
`getNumChildren()`	`Integer`	Recupera o número de filhos.
`getPaddingBottom()`	`Number\|null`	Recupera o padding da parte de baixo, em pontos.
`getPaddingLeft()`	`Number\|null`	Recupera o padding esquerdo, em pontos.
`getPaddingRight()`	`Number\|null`	Recupera o padding direito, em pontos.
`getPaddingTop()`	`Number\|null`	Recupera o padding da parte de cima, em pontos.
`getParent()`	`ContainerElement\|null`	Recupera o elemento pai do elemento.
`getParentRow()`	`TableRow\|null`	Recupera o `TableRow` que contém o `TableCell` atual.
`getParentTable()`	`Table\|null`	Recupera o `Table` que contém o `TableCell` atual.
`getPreviousSibling()`	`Element\|null`	Recupera o elemento irmão anterior do elemento.
`getRowSpan()`	`Integer`	Recupera o intervalo de linhas, que é o número de linhas de células da tabela que esta célula abrange.
`getText()`	`String`	Recupera o conteúdo do elemento como uma string de texto.
`getTextAlignment()`	`TextAlignment\|null`	Recebe o alinhamento do texto.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`getVerticalAlignment()`	`VerticalAlignment\|null`	Recupera o `VerticalAlignment`.
`getWidth()`	`Number\|null`	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 indicado.
`insertListItem(childIndex, listItem)`	`ListItem`	Insere o `ListItem` especificado no índice indicado.
`insertListItem(childIndex, text)`	`ListItem`	Cria e insere um novo `ListItem` no índice especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insere o `Paragraph` especificado no índice indicado.
`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 indicado.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final do `Document`.
`merge()`	`TableCell\|null`	Mescla o elemento com o irmão anterior do mesmo tipo.
`removeChild(child)`	`TableCell`	Remove o elemento filho especificado.
`removeFromParent()`	`TableCell\|null`	Remove o elemento do pai.
`replaceText(searchPattern, replacement)`	`Element`	Substitui todas as ocorrências de um determinado padrão de texto por uma determinada 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 da parte de baixo, em pontos.
`setPaddingLeft(paddingLeft)`	`TableCell`	Define o padding esquerdo, 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, em pontos, da coluna que contém a célula atual.

Documentação detalhada

`appendHorizontalRule()`

Cria e anexa um novo HorizontalRule.

O HorizontalRule será incluído 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 do blob de imagem especificado.

O InlineImage será incluído em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`image`	`BlobSource`	os dados de 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 especificado.

O InlineImage será incluído em um novo Paragraph.

Parâmetros

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

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

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

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

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 independente 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: o novo 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

`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 em busca de um descendente do tipo especificado.

Parâmetros

Nome	Tipo	Descrição
`elementType`	`ElementType`	O tipo de elemento a ser pesquisado.

Retornar

RangeElement|null: 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 pesquisado.

Retornar

RangeElement|null: 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 é totalmente compatível, 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|null: um resultado da pesquisa que indica a posição do texto pesquisado ou nulo se não houver uma 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 do JavaScript não é totalmente compatível, 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 para pesquisar

Retornar

RangeElement|null: um resultado da pesquisa que indica a próxima posição do texto pesquisado ou nulo se não houver uma 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 de plano de fundo.

Retornar

String|null: 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 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 do 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 o intervalo de colunas, que é o número de colunas de células da tabela que esta célula abrange. As células não mescladas têm um intervalo de coluna de 1.

Retornar

Integer: o intervalo de colunas ou 0 para uma célula mesclada por 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.

Retornar

String|null: o URL do link ou nulo se o elemento contiver 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 elemento irmão tem o mesmo elemento pai e segue o elemento atual.

Retornar

Element|null: 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.

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 da parte de baixo, em pontos.

Retornar

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

Retornar

Number|null: 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|null: 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 da parte de cima, em pontos.

Retornar

Number|null: 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|null: 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|null: 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|null: 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|null: 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 intervalo de linhas, que é o número de linhas de células da tabela que esta célula abrange. As células não mescladas têm um intervalo de linha de 1.

Retornar

Integer: o intervalo de linhas ou 0 para uma célula mesclada por 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.

Retornar

String: o conteúdo do elemento como uma 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|null: o tipo de alinhamento de texto ou null se o texto tiver 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 elemento específico.

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|null: 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|null: 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 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 em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`image`	`BlobSource`	os dados de 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 especificado no índice indicado.

A imagem vai estar 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 especificado no índice indicado.

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: novo item da 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 especificado no índice indicado.

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 um novo 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 especificado no índice indicado.

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 do Document.

Retornar

Boolean: indica 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()`

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.

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|null: 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|null: 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 determinada 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 JavaScript. Por isso, é necessário inserir uma barra de escape antes de cada barra invertida no padrão.

Esses métodos usam 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 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 é um item na enumeração DocumentApp.Attribute e cada valor de propriedade é 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 da parte de baixo, em pontos.

Parâmetros

Nome	Tipo	Descrição
`paddingBottom`	`Number`	o padding da parte de baixo, 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 esquerdo, 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 direito, 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 da parte de cima, 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 atual será 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, em pontos, da coluna que contém a célula atual.

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

Class TableCell Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Métodos

Documentação detalhada

appendHorizontalRule()

Retornar

Autorização

appendImage(image)

Parâmetros

Retornar

Autorização

appendImage(image)

Parâmetros

Retornar

Autorização

appendListItem(listItem)

Parâmetros

Retornar

Autorização

appendListItem(text)

Parâmetros

Retornar

Autorização

appendParagraph(paragraph)

Parâmetros

Retornar

Autorização

appendParagraph(text)

Parâmetros

Retornar

Autorização

appendTable()

Retornar

Autorização

appendTable(cells)

Parâmetros

Retornar

Autorização

appendTable(table)

Parâmetros

Retornar

Autorização

clear()

Retornar

copy()

Retornar

Autorização

editAsText()

Retornar

findElement(elementType)

Parâmetros

Retornar

Autorização

findElement(elementType, from)

Parâmetros

Retornar

Autorização

findText(searchPattern)

Parâmetros

Retornar

Autorização

findText(searchPattern, from)

Parâmetros

Retornar

Autorização

getAttributes()

Retornar

Autorização

getBackgroundColor()

Retornar

Autorização

getChild(childIndex)

Parâmetros

Retornar

Autorização

getChildIndex(child)

Parâmetros

Retornar

Autorização

getColSpan()

Retornar

Class TableCell

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getBackgroundColor()`

`getChild(childIndex)`

`getChildIndex(child)`

`getColSpan()`

`getLinkUrl()`

`getNextSibling()`

`getNumChildren()`

`getPaddingBottom()`

`getPaddingLeft()`

`getPaddingRight()`

`getPaddingTop()`

`getParent()`

`getParentRow()`

`getParentTable()`

`getPreviousSibling()`

`getRowSpan()`

`getText()`

`getTextAlignment()`

`getType()`

`getVerticalAlignment()`

`getWidth()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`