Esta página foi traduzida pela API Cloud Translation.

Class Body

O conteúdo de uma guia em um arquivo do Documentos Google. O Body pode conter ListItem, Elementos Paragraph, Table e TableOfContents. Para mais informações sobre da estrutura do documento, consulte o guia para estendendo os Documentos Google.

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

var 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`	Anexa o `InlineImage` fornecido.
`appendListItem(listItem)`	`ListItem`	Anexa o `ListItem` fornecido.
`appendListItem(text)`	`ListItem`	Cria e anexa um novo `ListItem` com o conteúdo de texto especificado.
`appendPageBreak()`	`PageBreak`	Cria e anexa um novo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Anexa o `PageBreak` fornecido.
`appendParagraph(paragraph)`	`Paragraph`	Anexa o `Paragraph` fornecido.
`appendParagraph(text)`	`Paragraph`	Cria e anexa um novo `Paragraph` com 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 o `Table` fornecido.
`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 `Text` do elemento atual para edição.
`findElement(elementType)`	`RangeElement`	Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
`findElement(elementType, from)`	`RangeElement`	Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement`	Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
`findText(searchPattern, from)`	`RangeElement`	Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um 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 para o 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 inferior, em pontos.
`getMarginLeft()`	`Number`	Recupera a margem esquerda, em pontos.
`getMarginRight()`	`Number`	Recupera a margem direita.
`getMarginTop()`	`Number`	Recupera a margem superior.
`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`	Extrai 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.
`insertImage(childIndex, image)`	`InlineImage`	Insere o `InlineImage` fornecido no índice especificado.
`insertListItem(childIndex, listItem)`	`ListItem`	Insere o `ListItem` fornecido no índice especificado.
`insertListItem(childIndex, text)`	`ListItem`	Cria e insere um novo `ListItem` no índice especificado, contendo o valor o conteúdo do texto.
`insertPageBreak(childIndex)`	`PageBreak`	Cria e insere um novo `PageBreak` no índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Insere o `PageBreak` fornecido no índice especificado.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Insere o `Paragraph` fornecido no índice especificado.
`insertParagraph(childIndex, text)`	`Paragraph`	Cria e insere um novo `Paragraph` no índice especificado, contendo o valor o conteúdo do texto.
`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` fornecido 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 string de substituição específica, usando valores expressões idiomáticas.
`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[]`	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 final do `Document`.
`setLinkUrl(url)`	`Body`	Define o URL do link.

Documentação detalhada

`appendHorizontalRule()`

Cria e anexa um novo HorizontalRule.

O HorizontalRule vai ficar em um novo Paragraph.

Retornar

HorizontalRule: a nova regra horizontal.

Autorização

Os scripts que usam esse método precisam de 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 será contida 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`appendImage(image)`

Anexa o InlineImage fornecido.

O InlineImage vai estar contido 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`	Dados da imagem.

Retornar

InlineImage: a imagem anexada.

Autorização

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

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

`appendListItem(listItem)`

Anexa o ListItem fornecido.

Use essa versão do 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 precisam de 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 com o conteúdo de texto especificado.

Itens de lista consecutivos são adicionados como parte da mesma lista.

Parâmetros

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

Retornar

ListItem: o novo item da lista.

Autorização

Os scripts que usam esse método precisam de 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 vai ficar em um novo Paragraph.

Retornar

PageBreak: a nova quebra de página.

Autorização

Os scripts que usam esse método precisam de 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 o PageBreak fornecido.

O PageBreak vai ficar 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`appendParagraph(paragraph)`

Anexa o Paragraph fornecido.

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

Parâmetros

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

Retornar

Paragraph: o novo parágrafo.

Autorização

Os scripts que usam esse método precisam de 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 após a tabela, já que os documentos do Documentos Google não pode terminar com uma tabela.

Retornar

Table: a nova tabela.

Autorização

Os scripts que usam esse método precisam de 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 após a tabela, já que os documentos do Documentos Google não pode 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`appendTable(table)`

Anexa o Table fornecido.

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 após a tabela, já que os arquivos do Documentos Google não pode 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 precisam de 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 pai

Retornar

Body: a nova cópia.

Autorização

Os scripts que usam esse método precisam de 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).

Elementos filho totalmente contidos em um intervalo de texto excluído são removidos do elemento.

var 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 em texto do elemento atual.

`findElement(elementType)`

Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.

Parâmetros

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

Retornar

RangeElement: um resultado da pesquisa que indica a posição do elemento de pesquisa.

Autorização

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

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

`findElement(elementType, from)`

Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo RangeElement especificado.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 a partir do qual pesquisar.

Retornar

RangeElement: um resultado da pesquisa que indica a próxima posição do elemento de pesquisa.

Autorização

Os scripts que usam esse método precisam de 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 JavaScript não tem suporte total, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.

Parâmetros

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão a ser pesquisado

Retornar

RangeElement: um resultado da pesquisa que indica a posição do texto da pesquisa, ou nulo se não houver correspondem

Autorização

Os scripts que usam esse método precisam de 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 resultado da pesquisa.

Um subconjunto dos recursos de expressão regular JavaScript não tem suporte total, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.

Parâmetros

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão a ser pesquisado
`from`	`RangeElement`	o resultado da pesquisa a ser pesquisado

Retornar

RangeElement: um resultado da pesquisa que indica a próxima posição do texto da pesquisa, ou nulo se não houver correspondem

Autorização

Os scripts que usam esse método precisam de 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 da propriedade corresponde a um item na enumeração DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 precisam de 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.

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

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

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice do elemento filho a ser recuperado.

Retornar

Element: o elemento filho no índice especificado.

Autorização

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

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

`getChildIndex(child)`

Recupera o índice filho para o elemento filho especificado.

Parâmetros

Nome	Tipo	Descrição
`child`	`Element`	O elemento filho para o qual o índice será recuperado.

Retornar

Integer: o índice filho.

Autorização

Os scripts que usam esse método precisam de 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 cabeçalho cujos atributos devem ser recuperados.

Retornar

Object: um mapa dos atributos e seus valores atuais.

Autorização

Os scripts que usam esse método precisam de 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[]: as imagens da seção.

Autorização

Os scripts que usam esse método precisam de 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 da seção.

Autorização

Os scripts que usam esse método precisam de 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: a margem inferior, em pontos.

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 precisam de 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: a margem superior, em pontos.

Autorização

Os scripts que usam esse método precisam de 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.

var 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 precisam de 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 precisam de 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 precisam de 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 precisam de 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 precisam de 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 de seção.

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getTextAlignment()`

Extrai 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 texto alinhamentos ou se o alinhamento do texto nunca foi definido

Autorização

Os scripts que usam esse método precisam de 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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 de elemento.

Autorização

Os scripts que usam esse método precisam de 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 vai ficar em um novo Paragraph.

Parâmetros

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

Retornar

HorizontalRule: a nova regra horizontal.

Autorização

Os scripts que usam esse método precisam de 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.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual o elemento será inserido.
`image`	`BlobSource`	Dados da imagem.

Retornar

InlineImage: a imagem inline inserida.

Autorização

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

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

`insertImage(childIndex, image)`

Insere o InlineImage fornecido no índice especificado.

A imagem será contida em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`insertListItem(childIndex, listItem)`

Insere o ListItem fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`listItem`	`ListItem`	Item da lista a ser inserido.

Retornar

ListItem: o item da lista inserido.

Autorização

Os scripts que usam esse método precisam de 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 valor o conteúdo do texto.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`text`	`String`	Conteúdo de texto do item da lista.

Retornar

ListItem: o novo item da lista.

Autorização

Os scripts que usam esse método precisam de 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 vai estar contido em um novo Paragraph.

Parâmetros

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

Retornar

PageBreak: a nova quebra de página.

Autorização

Os scripts que usam esse método precisam de 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 fornecido no índice especificado.

O PageBreak vai ficar em um novo Paragraph.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`insertParagraph(childIndex, paragraph)`

Insere o Paragraph fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`paragraph`	`Paragraph`	O parágrafo a ser inserido.

Retornar

Paragraph: o parágrafo inserido.

Autorização

Os scripts que usam esse método precisam de 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 valor o conteúdo do texto.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`text`	`String`	O conteúdo do texto do parágrafo.

Retornar

Paragraph: o novo parágrafo.

Autorização

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

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

`insertTable(childIndex)`

Cria e insere um novo Table no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.

Retornar

Table: a nova tabela.

Autorização

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

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

`insertTable(childIndex, cells)`

Cria e insere um novo Table contendo as células especificadas no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`cells`	`String[][]`	O conteúdo do 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`insertTable(childIndex, table)`

Insere o Table fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	O índice no qual inserir.
`table`	`Table`	A tabela a ser inserida.

Retornar

Table: a tabela inserida.

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`replaceText(searchPattern, replacement)`

Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição específica, usando valores expressões idiomáticas.

O padrão de pesquisa é transmitido como uma string, não um objeto de expressão regular JavaScript. Por isso, você precisará fazer o escape de todas as barras invertidas do padrão.

Esse método usa a linguagem RE2 padrão do Google, de expressão, o que limita a sintaxe suportada.

O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.

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

Retornar

Element: o elemento atual

Autorização

Os scripts que usam esse método precisam de 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 a enumeração DocumentApp.Attribute e cada valor de propriedade é o novo valor a ser aplicada.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 precisam de 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`	Cabeçalho cujos atributos devem ser definidos.
`attributes`	`Object`	Um mapa de atributos e os valores para os definir.

Retornar

Body: o elemento atual.

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 precisam de 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 precisam de 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 precisam de 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`setText(text)`

Define o conteúdo como texto simples.

Observação: o conteúdo existente é apagado.

Parâmetros

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

Retornar

Body: o elemento atual.

Autorização

Os scripts que usam esse método precisam de 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var 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 precisam de 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 precisam de 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 dentro da seção.

Recupera o URL do link.

Retornar

String: o URL do link ou nulo se o elemento tiver vários valores para o atributo

Autorização

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

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

`getNextSibling()`

Obsoleto. Este 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getPreviousSibling()`

Obsoleto. Este 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 precisam de 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: se o elemento está no final da guia.

Autorização

Os scripts que usam esse método precisam de 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 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 precisam de autorização com um ou mais dos seguintes escopos:

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