Class Body

Corpo

Um elemento que representa o corpo de um documento. O Body pode conter elementos ListItem, Paragraph, Table e TableOfContents. Para mais informações sobre a estrutura dos documentos, consulte o guia para estender os Documentos Google.

O Body normalmente contém todo o conteúdo do documento, exceto HeaderSection, FooterSection e 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étodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa um novo InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAnexa o InlineImage especificado.
appendListItem(listItem)ListItemAnexa o ListItem especificado.
appendListItem(text)ListItemCria e anexa um novo ListItem com o conteúdo de texto especificado.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAnexa o PageBreak especificado.
appendParagraph(paragraph)ParagraphAnexa o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph com o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table contendo um TableCell para cada valor de string especificado.
appendTable(table)TableAnexa o Table especificado.
clear()BodyLimpa o conteúdo do elemento.
copy()BodyRetorna uma cópia profunda desanexada do elemento atual.
editAsText()TextExtrai uma versão Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho para o elemento filho especificado.
getHeadingAttributes(paragraphHeading)ObjectRecupera 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()NumberRecupera a margem inferior, em pontos.
getMarginLeft()NumberRecupera a margem esquerda, em pontos.
getMarginRight()NumberRecupera a margem direita.
getMarginTop()NumberRecupera a margem superior.
getNumChildren()IntegerRecupera o número de filhos.
getPageHeight()NumberRecupera a altura da página em pontos.
getPageWidth()NumberRecupera a largura da página em pontos.
getParagraphs()Paragraph[]Recupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElementRecupera o elemento pai do elemento.
getTables()Table[]Recupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um novo HorizontalRule no índice especificado.
insertImage(childIndex, image)InlineImageCria e insere um InlineImage do blob de imagem especificado, no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice especificado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, contendo o conteúdo do texto especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, contendo o conteúdo do texto especificado.
insertTable(childIndex)TableCria e insere um novo Table no índice especificado.
insertTable(childIndex, cells)TableCria e insere um novo Table contendo as células especificadas no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice especificado.
removeChild(child)BodyRemove o elemento filho especificado.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma string de substituição especificada, usando expressões regulares.
setAttributes(attributes)BodyDefine os atributos do elemento.
setHeadingAttributes(paragraphHeading, attributes)BodyDefine os atributos para o ParagraphHeading fornecido.
setMarginBottom(marginBottom)BodyDefine a margem inferior, em pontos.
setMarginLeft(marginLeft)BodyDefine a margem esquerda, em pontos.
setMarginRight(marginRight)BodyDefine a margem direita, em pontos.
setMarginTop(marginTop)BodyDefine a margem superior.
setPageHeight(pageHeight)BodyDefine a altura da página, em pontos.
setPageWidth(pageWidth)BodyDefine a largura da página em pontos.
setText(text)BodyDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)BodyDefine o alinhamento do texto.

Documentação detalhada

appendHorizontalRule()

Cria e anexa um novo HorizontalRule.

O HorizontalRule estará contido em um novo Paragraph.

Retorno

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 estará em um novo Paragraph.

Parâmetros

NomeTipoDescrição
imageBlobSourceos dados da imagem

Retorno

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

O InlineImage estará contido em um novo Paragraph.

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

Parâmetros

NomeTipoDescrição
imageInlineImageos dados da imagem

Retorno

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

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

Parâmetros

NomeTipoDescrição
listItemListItemo item da lista a ser anexado

Retorno

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

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

Parâmetros

NomeTipoDescrição
textStringo conteúdo de texto do item da lista

Retorno

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á contido em um novo Paragraph.

Retorno

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

O PageBreak estará contido em um novo Paragraph.

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

Parâmetros

NomeTipoDescrição
pageBreakPageBreaka quebra de página a ser anexada

Retorno

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

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

Parâmetros

NomeTipoDescrição
paragraphParagrapho parágrafo a ser anexado

Retorno

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

Parâmetros

NomeTipoDescrição
textStringo conteúdo de texto do parágrafo

Retorno

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 após a tabela, já que os documentos Google não podem terminar com uma tabela.

Retorno

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 após a tabela, já que os documentos Google não podem terminar com uma tabela.

Parâmetros

NomeTipoDescrição
cellsString[][]o conteúdo de texto das células da tabela para adicionar à nova tabela

Retorno

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

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

Parâmetros

NomeTipoDescrição
tableTableda tabela a ser anexada

Retorno

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.

Retorno

Body: o elemento atual


copy()

Retorna uma cópia profunda desanexada do elemento atual.

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

Retorno

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

Extrai 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().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);

Retorno

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

NomeTipoDescrição
elementTypeElementTypeo tipo de elemento a ser pesquisado

Retorno

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

Autorização

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

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

findElement(elementType, from)

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

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

NomeTipoDescrição
elementTypeElementTypeo tipo de elemento a ser pesquisado
fromRangeElemento resultado da pesquisa para pesquisar

Retorno

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

Autorização

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

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

findText(searchPattern)

Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.

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

O padrão de expressão regular fornecido é correspondido de maneira independente a cada bloco de texto contido no elemento atual.

Parâmetros

NomeTipoDescrição
searchPatternStringo padrão a ser pesquisado

Retorno

RangeElement: um resultado da pesquisa que indica a posição do texto da pesquisa ou nulo se não houver correspondência.

Autorização

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

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

findText(searchPattern, from)

Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado 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 é correspondido de maneira independente a cada bloco de texto contido no elemento atual.

Parâmetros

NomeTipoDescrição
searchPatternStringo padrão a ser pesquisado
fromRangeElemento resultado da pesquisa para pesquisar

Retorno

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

Autorização

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

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

getAttributes()

Recupera os atributos do elemento.

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

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]);
}

Retorno

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

NomeTipoDescrição
childIndexIntegero índice do elemento filho a ser recuperado

Retorno

Element: o elemento filho no índice especificado

Autorização

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

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

getChildIndex(child)

Recupera o índice filho para o elemento filho especificado.

Parâmetros

NomeTipoDescrição
childElemento elemento filho para o qual recuperar o índice

Retorno

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

NomeTipoDescrição
paragraphHeadingParagraphHeadingo cabeçalho cujos atributos serão recuperados

Retorno

Object: um mapa dos atributos e dos 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.

Retorno

InlineImage[]: 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.

Retorno

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

Retorno

Number: a margem de baixo, em pontos.

Autorização

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

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

getMarginLeft()

Recupera a margem esquerda, em pontos.

Retorno

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.

Retorno

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

Retorno

Number: a margem de cima, 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.");

Retorno

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.

Retorno

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.

Retorno

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

Retorno

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.

Retorno

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.

Retorno

Table[]: 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.

Retorno

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.

Retorno

TextAlignment: o tipo de alinhamento do texto, ou null se o texto contiver 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 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.');
}

Retorno

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 estará contido em um novo Paragraph.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento

Retorno

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

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
imageBlobSourceos dados da imagem

Retorno

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

A imagem estará em um novo Paragraph.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
imageInlineImageda imagem a ser inserida

Retorno

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

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir
listItemListItemo item da lista a ser inserido

Retorno

ListItem: 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 do texto especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir
textStringo conteúdo de texto do item da lista

Retorno

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á contido em um novo Paragraph.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento

Retorno

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á contido em um novo Paragraph.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
pageBreakPageBreaka quebra de página para inserir

Retorno

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

NomeTipoDescrição
childIndexIntegero índice no qual inserir
paragraphParagraphdo parágrafo a inserir

Retorno

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

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir
textStringo conteúdo de texto do parágrafo

Retorno

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

NomeTipoDescrição
childIndexIntegero índice no qual inserir

Retorno

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

NomeTipoDescrição
childIndexIntegero índice no qual inserir
cellsString[][]o conteúdo de texto das células da tabela para adicionar à nova tabela

Retorno

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

NomeTipoDescrição
childIndexIntegero índice no qual inserir
tableTablena tabela para inserir

Retorno

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

NomeTipoDescrição
childElemento elemento filho a ser removido

Retorno

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 string de substituição especificada, usando expressões regulares.

O padrão de pesquisa é transmitido como uma string, e não um objeto de expressão regular JavaScript. Por isso, você precisa evitar barras invertidas no padrão.

Esse método usa 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 maneira independente a 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

NomeTipoDescrição
searchPatternStringo padrão de regex a ser pesquisado
replacementStringo texto a ser usado como substituto

Retorno

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

NomeTipoDescrição
attributesObjectOs atributos do elemento.

Retorno

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

NomeTipoDescrição
paragraphHeadingParagraphHeadingo título cujos atributos serão definidos
attributesObjectum mapa de atributos e os valores para defini-los

Retorno

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

NomeTipoDescrição
marginBottomNumbera margem inferior, em pontos

Retorno

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

NomeTipoDescrição
marginLeftNumbera margem esquerda, em pontos

Retorno

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

NomeTipoDescrição
marginRightNumbera margem direita

Retorno

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

NomeTipoDescrição
marginTopNumbera margem superior, em pontos

Retorno

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

NomeTipoDescrição
pageHeightNumbera altura da página, em pontos

Retorno

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

NomeTipoDescrição
pageWidthNumbera largura da página, em pontos;

Retorno

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

NomeTipoDescrição
textStringo novo conteúdo de texto

Retorno

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

NomeTipoDescrição
textAlignmentTextAlignmento tipo de alinhamento de texto a ser aplicado

Retorno

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