Esta página foi traduzida pela API Cloud Translation.

Class Body

O conteúdo de uma guia em um documento do Google Docs. O Body pode conter elementos ListItem, Paragraph, Table e TableOfContents. Para mais informações sobre a estrutura do documento, consulte o guia para estender o Google Docs.

O Body geralmente contém todo o conteúdo da guia, exceto os elementos HeaderSection, FooterSection e FootnoteSection.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

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` que contém o conteúdo de texto especificado.
`appendPageBreak()`	`PageBreak`	Cria e anexa um novo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Acrescenta o `PageBreak` especificado.
`appendParagraph(paragraph)`	`Paragraph`	Acrescenta o `Paragraph` especificado.
`appendParagraph(text)`	`Paragraph`	Cria e anexa um novo `Paragraph` que contém o conteúdo de texto especificado.
`appendTable()`	`Table`	Cria e anexa um novo `Table`.
`appendTable(cells)`	`Table`	Anexa um novo `Table` que contém um `TableCell` para cada valor de string especificado.
`appendTable(table)`	`Table`	Acrescenta o `Table` especificado.
`clear()`	`Body`	Limpa o conteúdo do elemento.
`copy()`	`Body`	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.
`getChild(childIndex)`	`Element`	Recupera o elemento filho no índice especificado.
`getChildIndex(child)`	`Integer`	Recupera o índice filho do elemento filho especificado.
`getHeadingAttributes(paragraphHeading)`	`Object`	Recupera o conjunto de atributos do `ParagraphHeading` fornecido.
`getImages()`	`InlineImage[]\|null`	Recupera todos os `InlineImages` contidos na seção.
`getListItems()`	`ListItem[]\|null`	Recupera todos os `ListItems` contidos na seção.
`getMarginBottom()`	`Number\|null`	Recupera a margem inferior, em pontos.
`getMarginLeft()`	`Number\|null`	Recupera a margem esquerda, em pontos.
`getMarginRight()`	`Number\|null`	Recupera a margem direita.
`getMarginTop()`	`Number\|null`	Recupera a margem superior.
`getNumChildren()`	`Integer`	Recupera o número de filhos.
`getPageHeight()`	`Number\|null`	Recupera a altura da página, em pontos.
`getPageWidth()`	`Number\|null`	Recupera a largura da página em pontos.
`getParagraphs()`	`Paragraph[]\|null`	Recupera todos os `Paragraphs` contidos na seção (incluindo `ListItems`).
`getParent()`	`ContainerElement\|null`	Recupera o elemento pai do elemento.
`getTables()`	`Table[]\|null`	Recupera todos os `Tables` contidos na seção.
`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.
`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, contendo o conteúdo de texto especificado.
`insertPageBreak(childIndex)`	`PageBreak`	Cria e insere um novo `PageBreak` no índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Insere o `PageBreak` especificado no índice indicado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insere o `Paragraph` especificado no índice indicado.
`insertParagraph(childIndex, text)`	`Paragraph`	Cria e insere um novo `Paragraph` no índice especificado, contendo o conteúdo de texto 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.
`removeChild(child)`	`Body`	Remove o elemento filho especificado.
`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)`	`Body`	Define os atributos do elemento.
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	Define os atributos para o `ParagraphHeading` fornecido.
`setMarginBottom(marginBottom)`	`Body`	Define a margem inferior, em pontos.
`setMarginLeft(marginLeft)`	`Body`	Define a margem esquerda, em pontos.
`setMarginRight(marginRight)`	`Body`	Define a margem direita, em pontos.
`setMarginTop(marginTop)`	`Body`	Define a margem superior.
`setPageHeight(pageHeight)`	`Body`	Define a altura da página, em pontos.
`setPageWidth(pageWidth)`	`Body`	Define a largura da página, em pontos.
`setText(text)`	`Body`	Define o conteúdo como texto simples.
`setTextAlignment(textAlignment)`	`Body`	Define o alinhamento do texto.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`getFootnotes()`	`Footnote[]\|null`	Recupera todos os `Footnotes` contidos na seção.
`getLinkUrl()`	`String\|null`	Recupera o URL do link.
`getNextSibling()`	`Element\|null`	Recupera o próximo elemento irmão do elemento.
`getPreviousSibling()`	`Element\|null`	Recupera o elemento irmão anterior do elemento.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final do `Document`.
`setLinkUrl(url)`	`Body`	Define o URL do link.

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.

A imagem vai estar em um novo Paragraph.

Parâmetros

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

`appendImage(image)`

Acrescenta o InlineImage especificado.

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

Use esta versão de appendImage ao anexar uma cópia de um InlineImage.

Parâmetros

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

Use esta versão de appendListItem ao anexar uma cópia de um ListItem.

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 que contém o conteúdo de texto especificado.

Os itens consecutivos são adicionados como parte da mesma lista.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O conteúdo de texto do item da lista.

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

`appendPageBreak()`

Cria e anexa um novo PageBreak.

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

Retornar

PageBreak: a nova quebra de página.

Autorização

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

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

`appendPageBreak(pageBreak)`

Acrescenta o PageBreak especificado.

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

Use esta versão de appendPageBreak ao anexar uma cópia de um PageBreak.

Parâmetros

Nome	Tipo	Descrição
`pageBreak`	`PageBreak`	A quebra de página a ser anexada.

Retornar

PageBreak: a quebra de página 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

`appendParagraph(paragraph)`

Acrescenta o Paragraph especificado.

Use esta versão de appendParagraph ao anexar uma cópia de um Paragraph.

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 que contém o conteúdo de texto especificado.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O conteúdo de texto do parágrafo.

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.

Esse método também vai anexar um parágrafo vazio depois da tabela, já que os documentos do Google Docs não podem terminar com uma 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

`appendTable(cells)`

Anexa um novo Table que contém um TableCell para cada valor de string especificado.

Esse método também vai anexar um parágrafo vazio depois da tabela, já que os documentos do Google Docs não podem terminar com uma tabela.

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.

Use esta versão de appendTable ao anexar uma cópia de um Table. Esse método também vai anexar um parágrafo vazio depois da tabela, já que os documentos do Google Docs não podem terminar com uma tabela.

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

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

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

`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

`getHeadingAttributes(paragraphHeading)`

Recupera o conjunto de atributos do ParagraphHeading fornecido.

Parâmetros

Nome	Tipo	Descrição
`paragraphHeading`	`ParagraphHeading`	O cabeçalho cujos atributos devem ser recuperados.

Retornar

Object: um mapa dos atributos e os valores atuais deles.

Autorização

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

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

`getImages()`

Recupera todos os InlineImages contidos na seção.

Retornar

InlineImage[]|null: as imagens da seçã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

`getListItems()`

Recupera todos os ListItems contidos na seção.

Retornar

ListItem[]|null: os itens da lista de seções.

Autorização

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

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

`getMarginBottom()`

Recupera a margem inferior, em pontos.

Retornar

Number|null: a margem 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

`getMarginLeft()`

Recupera a margem esquerda, em pontos.

Retornar

Number|null: a margem 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

`getMarginRight()`

Recupera a margem direita.

Retornar

Number|null: a margem 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

`getMarginTop()`

Recupera a margem superior.

Retornar

Number|null: a margem 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

`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

`getPageHeight()`

Recupera a altura da página, em pontos.

Retornar

Number|null: a altura da página, 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

`getPageWidth()`

Recupera a largura da página em pontos.

Retornar

Number|null: a largura da página, 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

`getParagraphs()`

Recupera todos os Paragraphs contidos na seção (incluindo ListItems).

Retornar

Paragraph[]|null: os parágrafos da seçã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

`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

`getTables()`

Recupera todos os Tables contidos na seção.

Retornar

Table[]|null: as tabelas de seçã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

`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

`insertHorizontalRule(childIndex)`

Cria e insere um novo HorizontalRule no índice especificado.

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice em que o elemento será inserido.
`image`	`BlobSource`	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 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 será inserido.
`listItem`	`ListItem`	O item da lista a ser inserido.

Retornar

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

`insertListItem(childIndex, text)`

Cria e insere um novo ListItem no índice especificado, contendo o conteúdo de texto especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice em que será inserido.
`text`	`String`	O conteúdo de texto do item da lista.

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

`insertPageBreak(childIndex)`

Cria e insere um novo PageBreak no índice especificado.

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

Parâmetros

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

Retornar

PageBreak: a nova quebra de página.

Autorização

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

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

`insertPageBreak(childIndex, pageBreak)`

Insere o PageBreak especificado no índice indicado.

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice em que o elemento será inserido.
`pageBreak`	`PageBreak`	A quebra de página a ser inserida.

Retornar

PageBreak: a quebra de página 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

`insertParagraph(childIndex, paragraph)`

Insere o Paragraph especificado no índice indicado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice em que 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, contendo o conteúdo de texto especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice em que será inserido.
`text`	`String`	O conteúdo de texto do parágrafo.

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 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 será inserido.
`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 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

`removeChild(child)`

Remove o elemento filho especificado.

Parâmetros

Nome	Tipo	Descrição
`child`	`Element`	O elemento filho a ser removido.

Retornar

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

`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

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

`setHeadingAttributes(paragraphHeading, attributes)`

Define os atributos para o ParagraphHeading fornecido.

Parâmetros

Nome	Tipo	Descrição
`paragraphHeading`	`ParagraphHeading`	O cabeçalho cujos atributos precisam ser definidos.
`attributes`	`Object`	Um mapa de atributos e os valores a serem definidos.

Retornar

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

`setMarginBottom(marginBottom)`

Define a margem inferior, em pontos.

Parâmetros

Nome	Tipo	Descrição
`marginBottom`	`Number`	A margem inferior, em pontos.

Retornar

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

`setMarginLeft(marginLeft)`

Define a margem esquerda, em pontos.

Parâmetros

Nome	Tipo	Descrição
`marginLeft`	`Number`	A margem esquerda, em pontos.

Retornar

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

`setMarginRight(marginRight)`

Define a margem direita, em pontos.

Parâmetros

Nome	Tipo	Descrição
`marginRight`	`Number`	A margem direita.

Retornar

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

`setMarginTop(marginTop)`

Define a margem superior.

Parâmetros

Nome	Tipo	Descrição
`marginTop`	`Number`	A margem superior, em pontos.

Retornar

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

`setPageHeight(pageHeight)`

Define a altura da página, em pontos.

Parâmetros

Nome	Tipo	Descrição
`pageHeight`	`Number`	A altura da página, em pontos.

Retornar

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

`setPageWidth(pageWidth)`

Define a largura da página, em pontos.

Parâmetros

Nome	Tipo	Descrição
`pageWidth`	`Number`	A largura da página, em pontos.

Retornar

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

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

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

Métodos obsoletos

`getFootnotes()`

Obsoleto. Esse elemento não pode conter um Footnote.

Recupera todos os Footnotes contidos na seção.

Retornar

Footnote[]|null: as notas de rodapé da seçã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

`getLinkUrl()`

Obsoleto. Em vez de aplicar um link a uma seção inteira, aplique-o a um elemento dentro da seção.

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

Obsoleto. Esse elemento não tem irmãos.

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

`getPreviousSibling()`

Obsoleto. Esse elemento não tem irmãos.

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

`isAtDocumentEnd()`

Obsoleto. Esse método não é confiável para HeaderSection.

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

`setLinkUrl(url)`

Obsoleto. Em vez de aplicar um link a uma seção inteira, aplique-o a um elemento dentro da seção.

Define o URL do link.

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	o URL do link

Retornar

Body: 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 Body Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Métodos

Métodos obsoletos

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

appendPageBreak()

Retornar

Autorização

appendPageBreak(pageBreak)

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

getChild(childIndex)

Parâmetros

Retornar

Autorização

getChildIndex(child)

Class Body

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendPageBreak()`

`appendPageBreak(pageBreak)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getHeadingAttributes(paragraphHeading)`

`getImages()`

`getListItems()`

`getMarginBottom()`

`getMarginLeft()`

`getMarginRight()`

`getMarginTop()`

`getNumChildren()`

`getPageHeight()`

`getPageWidth()`

`getParagraphs()`

`getParent()`

`getTables()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`