Esta página foi traduzida pela API Cloud Translation.

Class Body

Um elemento que representa um corpo de documento. O Body pode conter elementos ListItem, Paragraph, Table e TableOfContents. Para saber mais sobre a estrutura de documentos, consulte o guia sobre como estender o Documentos Google.

O Body normalmente tem o conteúdo completo do documento, exceto HeaderSection, FooterSection e todos os elementos FootnoteSection.

var doc = DocumentApp.getActiveDocument();
var body = doc.getBody();

// Append a paragraph and a page break to the document 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 uma nova `InlineImage` do blob de imagem especificado.
`appendImage(image)`	`InlineImage`	Anexa a `InlineImage` fornecida.
`appendListItem(listItem)`	`ListItem`	Anexa a `ListItem` fornecida.
`appendListItem(text)`	`ListItem`	Cria e anexa uma nova `ListItem` contendo o conteúdo de texto especificado.
`appendPageBreak()`	`PageBreak`	Cria e anexa um novo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Anexa a `PageBreak` fornecida.
`appendParagraph(paragraph)`	`Paragraph`	Anexa a `Paragraph` fornecida.
`appendParagraph(text)`	`Paragraph`	Cria e anexa uma nova `Paragraph` contendo o conteúdo de texto especificado.
`appendTable()`	`Table`	Cria e anexa um novo `Table`.
`appendTable(cells)`	`Table`	Anexa um novo `Table` contendo um `TableCell` para cada valor de string especificado.
`appendTable(table)`	`Table`	Anexa a `Table` fornecida.
`clear()`	`Body`	Limpa o conteúdo do elemento.
`copy()`	`Body`	Retorna uma cópia detalhada e removida do elemento atual.
`editAsText()`	`Text`	Recebe uma versão de `Text` do elemento atual para edição.
`findElement(elementType)`	`RangeElement`	Pesquisa o conteúdo do elemento para um descendente do tipo especificado.
`findElement(elementType, from)`	`RangeElement`	Pesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela `RangeElement` especificada.
`findText(searchPattern)`	`RangeElement`	Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
`findText(searchPattern, from)`	`RangeElement`	Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
`getAttributes()`	`Object`	Recupera os atributos do elemento.
`getChild(childIndex)`	`Element`	Recupera o elemento filho no índice filho especificado.
`getChildIndex(child)`	`Integer`	Recupera o índice filho do elemento filho especificado.
`getHeadingAttributes(paragraphHeading)`	`Object`	Recupera o conjunto de atributos para o `ParagraphHeading` fornecido.
`getImages()`	`InlineImage[]`	Recupera todos os `InlineImages` contidos na seção.
`getListItems()`	`ListItem[]`	Recupera todos os `ListItems` contidos na seção.
`getMarginBottom()`	`Number`	Recupera a margem de baixo, em pontos.
`getMarginLeft()`	`Number`	Recupera a margem esquerda em pontos.
`getMarginRight()`	`Number`	Recupera a margem direita.
`getMarginTop()`	`Number`	Recupera a margem de cima.
`getNumChildren()`	`Integer`	Recupera o número de filhos.
`getPageHeight()`	`Number`	Recupera a altura da página em pontos.
`getPageWidth()`	`Number`	Recupera a largura da página em pontos.
`getParagraphs()`	`Paragraph[]`	Recupera todos os `Paragraphs` contidos na seção (incluindo `ListItems`).
`getParent()`	`ContainerElement`	Recupera o elemento pai do elemento.
`getTables()`	`Table[]`	Recupera todos os `Tables` contidos na seção.
`getText()`	`String`	Recupera o conteúdo do elemento como uma string de texto.
`getTextAlignment()`	`TextAlignment`	Recebe o alinhamento do texto.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Cria e insere um novo `HorizontalRule` no índice especificado.
`insertImage(childIndex, image)`	`InlineImage`	Cria e insere um `InlineImage` a partir do blob de imagem especificado no índice especificado.
`insertImage(childIndex, image)`	`InlineImage`	Insere o `InlineImage` especificado no índice especificado.
`insertListItem(childIndex, listItem)`	`ListItem`	Insere o `ListItem` especificado no índice especificado.
`insertListItem(childIndex, text)`	`ListItem`	Cria e insere um novo `ListItem` no índice especificado, com 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 especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insere o `Paragraph` especificado no índice especificado.
`insertParagraph(childIndex, text)`	`Paragraph`	Cria e insere um novo `Paragraph` no índice especificado, com 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` com as células especificadas, no índice especificado.
`insertTable(childIndex, table)`	`Table`	Insere o `Table` especificado no índice especificado.
`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 de cima.
`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[]`	Recupera todos os `Footnotes` contidos na seção.
`getLinkUrl()`	`String`	Recupera o URL do link.
`getNextSibling()`	`Element`	Recupera o próximo elemento irmão do elemento.
`getPreviousSibling()`	`Element`	Recupera o elemento irmão anterior do elemento.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no fim do `Document`.
`setLinkUrl(url)`	`Body`	Define o URL do link.

Documentação detalhada

`appendHorizontalRule()`

Cria e anexa um novo HorizontalRule.

O HorizontalRule estará 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 uma nova InlineImage do blob de imagem especificado.

A imagem estará contida em um novo Paragraph.

Parâmetros

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

`appendImage(image)`

Anexa a InlineImage fornecida.

O InlineImage estará em um novo Paragraph.

Use essa versão do appendImage ao anexar uma cópia de um InlineImage existente.

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

Anexa a ListItem fornecida.

Use essa versão do appendListItem ao anexar uma cópia de um ListItem existente.

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 uma nova ListItem contendo o conteúdo de texto especificado.

Os itens consecutivos de lista 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 estará 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)`

Anexa a PageBreak fornecida.

O PageBreak estará em um novo Paragraph.

Use essa versão do appendPageBreak ao anexar uma cópia de um PageBreak existente.

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

Anexa a Paragraph fornecida.

Use essa versão do appendParagraph ao anexar uma cópia de um Paragraph existente.

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 uma nova Paragraph contendo o conteúdo de texto especificado.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	conteúdo do 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 anexa um parágrafo vazio depois da tabela, porque os documentos do Documentos Google 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 contendo um TableCell para cada valor de string especificado.

Esse método também anexa um parágrafo vazio depois da tabela, porque os documentos do Documentos Google 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 ser adicionado à 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)`

Anexa a Table fornecida.

Use essa versão do appendTable ao anexar uma cópia de um Table existente. Esse método também anexa um parágrafo vazio depois da tabela, porque os documentos do Documentos Google 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 removida do elemento atual.

Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um pai.

Retornar

Body: 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 de Text do elemento atual para edição.

Use a 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.

var body = DocumentApp.getActiveDocument().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Retornar

Text: uma versão em texto do elemento atual

`findElement(elementType)`

Pesquisa o conteúdo do elemento para um descendente do tipo especificado.

Parâmetros

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

Retornar

RangeElement: um resultado 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 um descendente do tipo especificado, começando pela RangeElement especificada.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parâmetros

Nome	Tipo	Descrição
`elementType`	`ElementType`	o tipo de elemento a ser pesquisado
`from`	`RangeElement`	o resultado da pesquisa

Retornar

RangeElement: um resultado da pesquisa indicando 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 o padrão de texto especificado usando expressões regulares.

Um subconjunto dos recursos de expressão regular em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde de maneira independente para 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 indicando a posição do texto de 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 o padrão de texto especificado, começando com um determinado resultado da pesquisa.

Um subconjunto dos recursos de expressão regular em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde de maneira independente para 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

Retornar

RangeElement: um resultado da pesquisa que indica a próxima posição do texto de pesquisa ou, se não houver correspondência, será nulo.

Autorização

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

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

`getAttributes()`

Recupera os atributos do elemento.

O resultado é um objeto que contém uma propriedade para cada atributo de elemento válido, em que cada nome de propriedade corresponde a um item na enumeração DocumentApp.Attribute.

var body = DocumentApp.getActiveDocument().getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	í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 é possível recuperar o índice

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 para o ParagraphHeading fornecido.

Parâmetros

Nome	Tipo	Descrição
`paragraphHeading`	`ParagraphHeading`	o título cujos atributos serão 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[]: 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[]: 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 de baixo, em pontos.

Retornar

Number: 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: 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: 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 de cima.

Retornar

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Retornar

Integer: o número de crianças.

Autorização

Os scripts que usam esse mé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: 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: 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[]: 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: 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[]: as tabelas 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

`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 contiver vários tipos de alinhamento de texto ou se o alinhamento do texto nunca tiver sido definido

Autorização

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

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

`getType()`

Recupera o ElementType do elemento.

Use getType() para determinar o tipo exato de um determinado elemento.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Retornar

ElementType: o tipo 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

`insertHorizontalRule(childIndex)`

Cria e insere um novo HorizontalRule no índice especificado.

O HorizontalRule estará 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 a partir 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`	os dados da imagem

Retornar

InlineImage: a imagem in-line inserida.

Autorização

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

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

`insertImage(childIndex, image)`

Insere o InlineImage especificado no índice especificado.

A imagem estará 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 in-line inserida.

Autorização

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

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

`insertListItem(childIndex, listItem)`

Insere o ListItem especificado no índice especificado.

Parâmetros

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

Retornar

ListItem: o 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, com o conteúdo de texto especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que a inserçã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

`insertPageBreak(childIndex)`

Cria e insere um novo PageBreak no índice especificado.

O PageBreak estará 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 especificado.

O PageBreak estará em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`pageBreak`	`PageBreak`	o intervalo de [idade] para inserir

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

Parâmetros

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que a inserção
`text`	`String`	conteúdo do 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 a inserção

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 com as células especificadas, no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que a inserção
`cells`	`String[][]`	o conteúdo de texto das células da tabela a ser adicionado à 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 especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que a inserção
`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, e não como um objeto JavaScript de expressão regular. Por isso, é preciso evitar barras invertidas no padrão.

Esses métodos usam a biblioteca de expressão regular RE2 do Google, que limita a sintaxe compatível.

O padrão de expressão regular fornecido corresponde de maneira independente para cada bloco de texto contido no elemento atual.

var body = DocumentApp.getActiveDocument().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parâmetros

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão regex a ser pesquisado
`replacement`	`String`	o texto a ser substituído

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

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parâmetros

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

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 título cujos atributos serão definidos
`attributes`	`Object`	um mapa de atributos e os valores para defini-los

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 de baixo, 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 de cima.

Parâmetros

Nome	Tipo	Descrição
`marginTop`	`Number`	margem de cima, 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 existente é apagado.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	o conteúdo do novo 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parâmetros

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

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[]: 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 link a um elemento na seção.

Recupera o URL do link.

Retornar

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

`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: 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 fim do Document.

Retornar

Boolean: se o elemento está no final do documento.

Autorização

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

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

`setLinkUrl(url)`

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

Define o URL do link.

Parâmetros

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