Class Paragraph

Parágrafo

Um elemento que representa um parágrafo. Um Paragraph pode conter os elementos Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak e Text. Para mais informações sobre a estrutura de documentos, consulte o guia sobre como estender o Documentos Google.

Paragraphs não pode conter caracteres de nova linha. Os caracteres de nova linha ("\n") são convertidos em caracteres de quebra de linha ("\r").

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

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Métodos

MétodoTipo de retornoBreve descrição
addPositionedImage(image)PositionedImageCria e insere um novo PositionedImage a partir do blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa um novo InlineImage a partir do blob de imagem especificado.
appendInlineImage(image)InlineImageAnexa o InlineImage fornecido.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAnexa o PageBreak fornecido.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAnexa o elemento Text fornecido.
clear()ParagraphLimpa o conteúdo do elemento.
copy()ParagraphRetorna uma cópia profunda e separada do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento de um descendente do tipo especificado, a partir do RangeElement especificado.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para identificar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado de pesquisa.
getAlignment()HorizontalAlignmentRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getHeading()ParagraphHeadingRecupera o ParagraphHeading.
getIndentEnd()NumberRecupera o recuo final, em pontos.
getIndentFirstLine()NumberRecupera o recuo da primeira linha em pontos.
getIndentStart()NumberRecupera o recuo inicial.
getLineSpacing()NumberRecupera o espaçamento entre linhas em pontos.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Obtém todos os objetos PositionedImage ancorados ao parágrafo.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getSpacingAfter()NumberRecupera o espaçamento após o elemento em pontos.
getSpacingBefore()NumberRecupera o espaço antes do elemento, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentObtém o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um HorizontalRule no índice especificado.
insertInlineImage(childIndex, image)InlineImageCria e insere um novo InlineImage a partir do blob de imagem especificado, no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice especificado.
insertText(childIndex, text)TextCria e insere um novo elemento de texto no índice especificado.
insertText(childIndex, text)TextInsere o elemento Text fornecido no índice especificado, com o conteúdo de texto especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
isLeftToRight()BooleanRecupera a configuração da esquerda para a direita.
merge()ParagraphMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)ParagraphRemove o elemento filho especificado.
removeFromParent()ParagraphRemove o elemento do pai.
removePositionedImage(id)BooleanRemove um PositionedImage pelo ID da imagem.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares.
setAlignment(alignment)ParagraphDefine o HorizontalAlignment.
setAttributes(attributes)ParagraphDefine os atributos do elemento.
setHeading(heading)ParagraphDefine o ParagraphHeading.
setIndentEnd(indentEnd)ParagraphDefine o recuo final, em pontos.
setIndentFirstLine(indentFirstLine)ParagraphDefine o recuo da primeira linha, em pontos.
setIndentStart(indentStart)ParagraphDefine o recuo inicial, em pontos.
setLeftToRight(leftToRight)ParagraphDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ParagraphDefine o espaçamento entre linhas, como uma quantidade que indica o número de linhas a serem usadas no espaçamento.
setLinkUrl(url)ParagraphDefine o URL do link.
setSpacingAfter(spacingAfter)ParagraphDefine o espaçamento após o elemento em pontos.
setSpacingBefore(spacingBefore)ParagraphDefine o espaçamento antes do elemento, em pontos.
setText(text)voidDefine o conteúdo do parágrafo como texto.
setTextAlignment(textAlignment)ParagraphDefine o alinhamento do texto.

Documentação detalhada

addPositionedImage(image)

Cria e insere um novo PositionedImage a partir do blob de imagem especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image =
  UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png');

// Adds the image to the document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parâmetros

NomeTipoDescrição
imageBlobSourceDados da imagem.

Retornar

PositionedImage: a nova imagem posicionada.

Autorização

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

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

appendHorizontalRule()

Cria e anexa um novo HorizontalRule.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

Retornar

HorizontalRule: a nova regra horizontal.

Autorização

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

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

appendInlineImage(image)

Cria e anexa um novo InlineImage a partir do blob de imagem especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp
  .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png');

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parâmetros

NomeTipoDescrição
imageBlobSourceDados da imagem.

Retornar

InlineImage: a imagem anexada.

Autorização

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

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

appendInlineImage(image)

Anexa o InlineImage fornecido.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();;

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parâmetros

NomeTipoDescrição
imageInlineImageDados da imagem.

Retornar

InlineImage: a imagem anexada.

Autorização

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

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

Retornar

PageBreak: o novo elemento de quebra de página.

Autorização

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

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual existir em uma célula da tabela, o script gerará uma exceção.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

Parâmetros

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

Retornar

PageBreak: o elemento de quebra de página anexado.

Autorização

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

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

appendText(text)

Cria e anexa um novo elemento Text com o conteúdo especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

Parâmetros

NomeTipoDescrição
textStringO conteúdo do texto.

Retornar

Text: o novo elemento de texto.

Autorização

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

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

appendText(text)

Anexa o elemento Text fornecido.

 // Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

Parâmetros

NomeTipoDescrição
textTextO elemento de texto a ser anexado.

Retornar

Text: o elemento de texto anexado.

Autorização

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

Paragraph: o elemento atual


copy()

Retorna uma cópia profunda e separada do elemento atual.

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

Retornar

Paragraph: a nova cópia.

Autorização

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

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

editAsText()

Recebe uma versão Text do elemento atual para edição.

Use editAsText para manipular o conteúdo dos elementos como rich text. O modo editAsText ignora elementos não textuais, como InlineImage e HorizontalRule.

Os elementos filhos totalmente contidos em um intervalo de texto excluído são removidos do elemento.

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

NomeTipoDescrição
elementTypeElementTypeo tipo de elemento a ser pesquisado

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 de um descendente do tipo especificado, a partir do 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 a partir do qual pesquisar

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 requerem 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 identificar o padrão de texto especificado usando expressões regulares.

Um subconjunto dos recursos de expressão regular JavaScript não é totalmente compatível, 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

Retornar

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

Autorização

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

Um subconjunto dos recursos de expressão regular JavaScript não é totalmente compatível, 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 a partir do qual pesquisar

Retornar

RangeElement: um resultado da pesquisa indicando 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 requerem autorização com um ou mais dos seguintes escopos:

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

getAlignment()

Recupera o HorizontalAlignment.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the console.
console.log(paragraph.getAlignment().toString());

Retornar

HorizontalAlignment: o alinhamento.

Autorização

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

Retornar

Element: o elemento filho no índice especificado

Autorização

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

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

Retornar

Integer: o índice filho

Autorização

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

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

getHeading()

Recupera o ParagraphHeading.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

Retornar

ParagraphHeading: o cabeçalho.

Autorização

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

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

getIndentEnd()

Recupera o recuo final, em pontos.

Retornar

Number: o recuo final, em pontos.

Autorização

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

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

getIndentFirstLine()

Recupera o recuo da primeira linha em pontos.

Retornar

Number: o recuo da primeira linha, em pontos.

Autorização

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

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

getIndentStart()

Recupera o recuo inicial.

Retornar

Number: o recuo inicial

Autorização

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

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

getLineSpacing()

Recupera o espaçamento entre linhas em pontos.

Retornar

Number: o espaçamento entre linhas, em pontos.

Autorização

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

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

getLinkUrl()

Recupera o URL do link.

Retornar

String: 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 requerem autorização com um ou mais dos seguintes escopos:

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

getNextSibling()

Recupera o próximo elemento irmão do elemento.

O próximo 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 requerem 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 requerem 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 requerem autorização com um ou mais dos seguintes escopos:

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

getPositionedImage(id)

Recebe um PositionedImage pelo ID da imagem.

Parâmetros

NomeTipoDescrição
idStringo ID da imagem

Retornar

PositionedImage: a imagem posicionada

Autorização

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

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

getPositionedImages()

Obtém todos os objetos PositionedImage ancorados ao parágrafo.

Retornar

PositionedImage[]: uma lista de imagens posicionadas

Autorização

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

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

getPreviousSibling()

Recupera o elemento irmão anterior do elemento.

O irmão anterior tem o mesmo pai e precede o elemento atual.

Retornar

Element: o elemento irmão anterior.

Autorização

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

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

getSpacingAfter()

Recupera o espaçamento após o elemento em pontos.

Retornar

Number: o espaçamento após o elemento, em pontos.

Autorização

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

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

getSpacingBefore()

Recupera o espaço antes do elemento, em pontos.

Retornar

Number: o espaçamento antes do elemento, em pontos.

Autorização

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

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

getTextAlignment()

Obtém 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 alinhamentos de texto ou se o alinhamento do texto nunca tiver sido definido

Autorização

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

Autorização

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

Parâmetros

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

Retornar

HorizontalRule: o novo elemento de regra horizontal

Autorização

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

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

insertInlineImage(childIndex, image)

Cria e insere um novo InlineImage a partir do blob de imagem especificado, no índice especificado.

Parâmetros

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

Retornar

InlineImage: o elemento de imagem inline inserido

Autorização

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

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

insertInlineImage(childIndex, image)

Insere o InlineImage especificado no índice especificado.

Parâmetros

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

Retornar

InlineImage: o elemento de imagem inline inserido

Autorização

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

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.

Parâmetros

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

Retornar

PageBreak: o novo elemento de quebra de página

Autorização

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

Observação: PageBreaks não pode estar contido em TableCells. Se o elemento atual estiver contido em uma célula da tabela, uma exceção será lançada.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
pageBreakPageBreako intervalo de p[idade para inserir

Retornar

PageBreak: o elemento de quebra de página inserido

Autorização

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

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

insertText(childIndex, text)

Cria e insere um novo elemento de texto no índice especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
textStringo conteúdo do texto

Retornar

Text: o novo elemento de texto

Autorização

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

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

insertText(childIndex, text)

Insere o elemento Text fornecido no índice especificado, com o conteúdo de texto especificado.

Parâmetros

NomeTipoDescrição
childIndexIntegero índice no qual inserir o elemento
textTexto elemento de texto a ser inserido

Retornar

Text: o elemento de texto inserido

Autorização

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

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

isAtDocumentEnd()

Determina se o elemento está no final do Document.

Retornar

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

Autorização

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

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

isLeftToRight()

Recupera a configuração da esquerda para a direita.

Retornar

Boolean: a configuração da esquerda para a direita

Autorização

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

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

merge()

Mescla o elemento com o irmão anterior do mesmo tipo.

Somente elementos do mesmo ElementType podem ser mesclados. Todos os elementos filhos contidos no elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do documento.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Retornar

Paragraph: o elemento mesclado.

Autorização

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

Retornar

Paragraph: o elemento atual

Autorização

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

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

removeFromParent()

Remove o elemento do pai.

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

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Retornar

Paragraph: o elemento removido.

Autorização

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

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

removePositionedImage(id)

Remove um PositionedImage pelo ID da imagem.

Parâmetros

NomeTipoDescrição
idStringo ID da imagem

Retornar

Boolean: se a imagem especificada foi removida ou não

Autorização

Os scripts que usam esse método requerem 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 é passado como uma string, não como um objeto de expressão regular JavaScript. Por isso, você precisa escapar quaisquer barras invertidas no padrão.

Esses métodos usam a biblioteca de expressões regulares RE2 do Google, que limita a sintaxe compatível.

O padrão de expressão regular fornecido é correspondido de 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 regex a ser pesquisado
replacementStringo texto a ser usado como substituição

Retornar

Element: o elemento atual

Autorização

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

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

setAlignment(alignment)

Define o HorizontalAlignment.

Parâmetros

NomeTipoDescrição
alignmentHorizontalAlignmento alinhamento horizontal

Retornar

Paragraph: o elemento atual

Autorização

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

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

setAttributes(attributes)

Define os atributos do elemento.

O parâmetro de atributos especificado precisa ser um objeto em que cada nome de propriedade é um item na enumeração DocumentApp.Attribute e cada valor de propriedade é o novo valor a ser aplicado.

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.

Retornar

Paragraph: o elemento atual.

Autorização

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

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

setHeading(heading)

Define o ParagraphHeading.

Parâmetros

NomeTipoDescrição
headingParagraphHeadingo título

Retornar

Paragraph: o elemento atual

Autorização

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

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

setIndentEnd(indentEnd)

Define o recuo final, em pontos.

Parâmetros

NomeTipoDescrição
indentEndNumbero recuo final, em pontos

Retornar

Paragraph: o elemento atual

Autorização

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

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

setIndentFirstLine(indentFirstLine)

Define o recuo da primeira linha, em pontos.

Parâmetros

NomeTipoDescrição
indentFirstLineNumbero recuo da primeira linha, em pontos

Retornar

Paragraph: o elemento atual

Autorização

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

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

setIndentStart(indentStart)

Define o recuo inicial, em pontos.

Parâmetros

NomeTipoDescrição
indentStartNumbero recuo inicial, em pontos

Retornar

Paragraph: o elemento atual

Autorização

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

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

setLeftToRight(leftToRight)

Define a configuração da esquerda para a direita.

Parâmetros

NomeTipoDescrição
leftToRightBooleana configuração da esquerda para a direita

Retornar

Paragraph: o elemento atual

Autorização

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

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

setLineSpacing(multiplier)

Define o espaçamento entre linhas, como uma quantidade que indica o número de linhas a serem usadas no espaçamento.

Parâmetros

NomeTipoDescrição
multiplierNumbero número de linhas

Retornar

Paragraph: o elemento atual

Autorização

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

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

setLinkUrl(url)

Define o URL do link.

Parâmetros

NomeTipoDescrição
urlStringo URL do link

Retornar

Paragraph: o elemento atual

Autorização

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

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

setSpacingAfter(spacingAfter)

Define o espaçamento após o elemento em pontos.

Parâmetros

NomeTipoDescrição
spacingAfterNumbero espaçamento após o elemento, em pontos

Retornar

Paragraph: o elemento atual

Autorização

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

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

setSpacingBefore(spacingBefore)

Define o espaçamento antes do elemento, em pontos.

Parâmetros

NomeTipoDescrição
spacingBeforeNumbero espaçamento antes do elemento, em pontos

Retornar

Paragraph: o elemento atual

Autorização

Os scripts que usam esse método requerem 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 do parágrafo como texto.

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

Parâmetros

NomeTipoDescrição
textStringo novo conteúdo de texto

Autorização

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

Retornar

Paragraph: o elemento atual

Autorização

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

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