Esta página foi traduzida pela API Cloud Translation.

Class Paragraph

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

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

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

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

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

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

Métodos

Método	Tipo de retorno	Breve descrição
`addPositionedImage(image)`	`PositionedImage`	Cria e insere um novo `PositionedImage` do blob de imagem especificado.
`appendHorizontalRule()`	`HorizontalRule`	Cria e anexa um novo `HorizontalRule`.
`appendInlineImage(image)`	`InlineImage`	Cria e anexa um novo `InlineImage` ao blob de imagem especificado.
`appendInlineImage(image)`	`InlineImage`	Acrescenta o `InlineImage` fornecido.
`appendPageBreak()`	`PageBreak`	Cria e anexa um novo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Acrescenta o `PageBreak` fornecido.
`appendText(text)`	`Text`	Cria e anexa um novo elemento `Text` com o conteúdo especificado.
`appendText(text)`	`Text`	Anexar o elemento `Text` fornecido.
`clear()`	`Paragraph`	Limpa o conteúdo do elemento.
`copy()`	`Paragraph`	Retorna uma cópia detalhada e separada 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 para encontrar um descendente do tipo especificado.
`findElement(elementType, from)`	`RangeElement`	Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo `RangeElement` especificado.
`findText(searchPattern)`	`RangeElement`	Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
`findText(searchPattern, from)`	`RangeElement`	Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado, começando com um determinado resultado da pesquisa.
`getAlignment()`	`HorizontalAlignment`	Recupera o `HorizontalAlignment`.
`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.
`getHeading()`	`ParagraphHeading`	Recupera o `ParagraphHeading`.
`getIndentEnd()`	`Number`	Recupera a indentação final, em pontos.
`getIndentFirstLine()`	`Number`	Recupera o recuo da primeira linha, em pontos.
`getIndentStart()`	`Number`	Recupera o recuo inicial.
`getLineSpacing()`	`Number`	Recupera o espaçamento entre linhas, em pontos.
`getLinkUrl()`	`String`	Recupera o URL do link.
`getNextSibling()`	`Element`	Recupera o próximo elemento irmão do elemento.
`getNumChildren()`	`Integer`	Recupera o número de crianças.
`getParent()`	`ContainerElement`	Recupera o elemento pai do elemento.
`getPositionedImage(id)`	`PositionedImage`	Recebe um `PositionedImage` pelo ID da imagem.
`getPositionedImages()`	`PositionedImage[]`	Recebe todos os objetos `PositionedImage` ancorados ao parágrafo.
`getPreviousSibling()`	`Element`	Recupera o elemento irmão anterior do elemento.
`getSpacingAfter()`	`Number`	Recupera o espaçamento após o elemento, em pontos.
`getSpacingBefore()`	`Number`	Recupera o espaçamento antes do elemento, em pontos.
`getText()`	`String`	Recupera o conteúdo do elemento como uma string de texto.
`getTextAlignment()`	`TextAlignment`	Recebe o alinhamento do texto.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Cria e insere um `HorizontalRule` no índice especificado.
`insertInlineImage(childIndex, image)`	`InlineImage`	Cria e insere um novo `InlineImage` do blob de imagem especificado no índice especificado.
`insertInlineImage(childIndex, image)`	`InlineImage`	Insere o `InlineImage` fornecido no índice especificado.
`insertPageBreak(childIndex)`	`PageBreak`	Cria e insere um novo `PageBreak` no índice especificado.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Insere o `PageBreak` fornecido no índice especificado.
`insertText(childIndex, text)`	`Text`	Cria e insere um novo elemento de texto no índice especificado.
`insertText(childIndex, text)`	`Text`	Insere o elemento `Text` especificado no índice especificado, com o conteúdo de texto especificado.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final da `Document`.
`isLeftToRight()`	`Boolean`	Recupera a configuração da esquerda para a direita.
`merge()`	`Paragraph`	Une o elemento ao elemento irmão anterior do mesmo tipo.
`removeChild(child)`	`Paragraph`	Remove o elemento filho especificado.
`removeFromParent()`	`Paragraph`	Remove o elemento do pai.
`removePositionedImage(id)`	`Boolean`	Remove um `PositionedImage` pelo ID da imagem.
`replaceText(searchPattern, replacement)`	`Element`	Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição usando expressões regulares.
`setAlignment(alignment)`	`Paragraph`	Define o `HorizontalAlignment`.
`setAttributes(attributes)`	`Paragraph`	Define os atributos do elemento.
`setHeading(heading)`	`Paragraph`	Define o `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`Paragraph`	Define o recuo final, em pontos.
`setIndentFirstLine(indentFirstLine)`	`Paragraph`	Define o recuo da primeira linha, em pontos.
`setIndentStart(indentStart)`	`Paragraph`	Define o recuo inicial, em pontos.
`setLeftToRight(leftToRight)`	`Paragraph`	Define a configuração da esquerda para a direita.
`setLineSpacing(multiplier)`	`Paragraph`	Define o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para o espaçamento.
`setLinkUrl(url)`	`Paragraph`	Define o URL do link.
`setSpacingAfter(spacingAfter)`	`Paragraph`	Define o espaçamento após o elemento, em pontos.
`setSpacingBefore(spacingBefore)`	`Paragraph`	Define o espaçamento antes do elemento, em pontos.
`setText(text)`	`void`	Define o conteúdo do parágrafo como texto.
`setTextAlignment(textAlignment)`	`Paragraph`	Define o alinhamento do texto.

Documentação detalhada

`addPositionedImage(image)`

Cria e insere um novo PositionedImage 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parâmetros

Nome	Tipo	Descrição
`image`	`BlobSource`	Dados da imagem.

Retornar

PositionedImage: a nova imagem posicionada.

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

`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 exigem 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 ao 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

Nome	Tipo	Descrição
`image`	`BlobSource`	Dados da imagem.

Retornar

InlineImage: a imagem anexada.

Autorização

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

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

`appendInlineImage(image)`

Acrescenta 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

Nome	Tipo	Descrição
`image`	`InlineImage`	Dados da imagem.

Retornar

InlineImage: a imagem anexada.

Autorização

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

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

`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 de tabela, uma exceção será gerada.

// 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 elemento de nova quebra de página.

Autorização

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

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

`appendPageBreak(pageBreak)`

Acrescenta o PageBreak fornecido.

Observação: PageBreaks não pode ser contido em TableCells. Se o elemento atual existir em uma célula da tabela, o script vai 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

Nome	Tipo	Descrição
`pageBreak`	`PageBreak`	A 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 exigem 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

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

Retornar

Text: o novo elemento 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

`appendText(text)`

Anexar 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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

Nome	Tipo	Descrição
`text`	`Text`	O elemento de texto a ser anexado.

Retornar

Text: o elemento de texto 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

`clear()`

Limpa o conteúdo do elemento.

Retornar

Paragraph: o elemento atual.

`copy()`

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

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

Retornar

Paragraph: a nova cópia.

Autorização

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

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

`editAsText()`

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

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

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

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

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

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

Retornar

Text: uma versão de texto do elemento atual

`findElement(elementType)`

Pesquisa o conteúdo do elemento para encontrar 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 exigem autorização com um ou mais dos seguintes escopos:

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

`findElement(elementType, from)`

Pesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parâmetros

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

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

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

`findText(searchPattern)`

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

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

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

Parâmetros

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

Retornar

RangeElement: 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 para encontrar o padrão de texto especificado, começando com um determinado resultado da pesquisa.

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

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

Parâmetros

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

Retornar

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

`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 exigem autorização com um ou mais dos seguintes escopos:

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

`getAttributes()`

Recupera os atributos do elemento.

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

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Retornar

Object: os atributos do elemento.

Autorização

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

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

`getChild(childIndex)`

Recupera o elemento filho no índice filho especificado.

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

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

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

Parâmetros

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

Retornar

Element: o elemento filho no índice especificado.

Autorização

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

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

`getChildIndex(child)`

Recupera o índice filho 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 exigem 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 título.

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

`getIndentEnd()`

Recupera a indentação final, em pontos.

Retornar

Number: o recuo final, 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

`getIndentFirstLine()`

Recupera o recuo da primeira linha, em pontos.

Retornar

Number: recuo da primeira linha, 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

`getIndentStart()`

Recupera o recuo inicial.

Retornar

Number: o recuo inicial

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

`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 exigem 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 tiver vários valores para esse atributo.

Autorização

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

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

`getNextSibling()`

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

O próximo irmão tem o mesmo pai e segue o elemento atual.

Retornar

Element: o próximo elemento irmão.

Autorização

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

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

`getNumChildren()`

Recupera o número de crianças.

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

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Retornar

Integer: o número de filhos.

Autorização

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

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

`getParent()`

Recupera o elemento pai do elemento.

O elemento pai contém o elemento atual.

Retornar

ContainerElement: o elemento pai.

Autorização

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

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

`getPositionedImage(id)`

Recebe um PositionedImage pelo ID da imagem.

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID da imagem

Retornar

PositionedImage: a imagem posicionada

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

`getPositionedImages()`

Recebe todos os objetos PositionedImage ancorados ao parágrafo.

Retornar

PositionedImage[]: uma lista de imagens posicionadas

Autorização

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

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

`getPreviousSibling()`

Recupera o elemento irmão anterior do elemento.

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

Retornar

Element: o elemento irmão anterior.

Autorização

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

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

`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 exigem 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çamento antes do elemento, em pontos.

Retornar

Number: o espaçamento antes do elemento, 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

`getText()`

Recupera o conteúdo do elemento como uma string de texto.

Retornar

String: o conteúdo do elemento como string de texto

Autorização

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

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

`getTextAlignment()`

Recebe o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

Retornar

TextAlignment: o tipo de alinhamento do texto ou null se o texto contém vários tipos de alinhamento ou se o alinhamento nunca foi 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.

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

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

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

Retornar

ElementType: o tipo de elemento.

Autorização

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

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

`insertHorizontalRule(childIndex)`

Cria e insere um HorizontalRule no índice especificado.

Parâmetros

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

Retornar

HorizontalRule: o novo elemento de 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

`insertInlineImage(childIndex, image)`

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`image`	`BlobSource`	os dados da imagem

Retornar

InlineImage: o elemento de imagem inline 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

`insertInlineImage(childIndex, image)`

Insere o InlineImage fornecido no índice especificado.

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`image`	`InlineImage`	os dados da imagem

Retornar

InlineImage: o elemento de imagem inline 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

`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 de tabela, uma exceção será gerada.

Parâmetros

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

Retornar

PageBreak: o novo elemento de 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 fornecido no índice especificado.

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

Parâmetros

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

Retornar

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

`insertText(childIndex, text)`

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`text`	`String`	o conteúdo do texto

Retornar

Text: o novo elemento 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

`insertText(childIndex, text)`

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

Parâmetros

Nome	Tipo	Descrição
`childIndex`	`Integer`	o índice em que o elemento será inserido
`text`	`Text`	o elemento de texto a ser inserido

Retornar

Text: o elemento de texto 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

`isAtDocumentEnd()`

Determina se o elemento está no final da Document.

Retornar

Boolean: se o elemento está no final da guia.

Autorização

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

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

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

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

`merge()`

Une o elemento ao elemento irmão anterior do mesmo tipo.

Só é possível mesclar elementos do mesmo ElementType. Todos os elementos filhos contidos no elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do documento.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Retornar

Paragraph: o elemento mesclado.

Autorização

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

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

`removeChild(child)`

Remove o elemento filho especificado.

Parâmetros

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

Retornar

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

`removeFromParent()`

Remove o elemento do pai.

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Retornar

Paragraph: o elemento removido.

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

`removePositionedImage(id)`

Remove um PositionedImage pelo ID da imagem.

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID da imagem

Retornar

Boolean: indica se a imagem especificada foi removida ou nã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

`replaceText(searchPattern, replacement)`

Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição usando expressões regulares.

O padrão de pesquisa é transmitido como uma string, não como um objeto de expressão regular do JavaScript. Por isso, é necessário inserir barras invertidas no padrão.

Esse método usa a biblioteca de expressões regulares RE2 do Google, que limita a sintaxe com suporte.

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

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

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

Parâmetros

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão de regex a ser pesquisado
`replacement`	`String`	o texto a ser usado como substituição

Retornar

Element: o elemento atual

Autorização

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

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

`setAlignment(alignment)`

Define o HorizontalAlignment.

Parâmetros

Nome	Tipo	Descrição
`alignment`	`HorizontalAlignment`	o alinhamento horizontal

Retornar

Paragraph: o elemento atual

Autorização

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

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

`setAttributes(attributes)`

Define os atributos do elemento.

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

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

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

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

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

Parâmetros

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

Retornar

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

`setHeading(heading)`

Define o ParagraphHeading.

Parâmetros

Nome	Tipo	Descrição
`heading`	`ParagraphHeading`	o título

Retornar

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

`setIndentEnd(indentEnd)`

Define o recuo final, em pontos.

Parâmetros

Nome	Tipo	Descrição
`indentEnd`	`Number`	o recuo final, em pontos

Retornar

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

`setIndentFirstLine(indentFirstLine)`

Define o recuo da primeira linha, em pontos.

Parâmetros

Nome	Tipo	Descrição
`indentFirstLine`	`Number`	o recuo da primeira linha, em pontos

Retornar

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

`setIndentStart(indentStart)`

Define o recuo inicial, em pontos.

Parâmetros

Nome	Tipo	Descrição
`indentStart`	`Number`	o recuo inicial, em pontos

Retornar

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

`setLeftToRight(leftToRight)`

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

Parâmetros

Nome	Tipo	Descrição
`leftToRight`	`Boolean`	a configuração da esquerda para a direita

Retornar

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

`setLineSpacing(multiplier)`

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

Parâmetros

Nome	Tipo	Descrição
`multiplier`	`Number`	o número de linhas

Retornar

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

`setLinkUrl(url)`

Define o URL do link.

Parâmetros

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

Retornar

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

`setSpacingAfter(spacingAfter)`

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

Parâmetros

Nome	Tipo	Descrição
`spacingAfter`	`Number`	o espaçamento após o elemento, em pontos

Retornar

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

`setSpacingBefore(spacingBefore)`

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

Parâmetros

Nome	Tipo	Descrição
`spacingBefore`	`Number`	o espaçamento antes do elemento, em pontos

Retornar

Paragraph: 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 do parágrafo como texto.

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

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	o novo conteúdo 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

`setTextAlignment(textAlignment)`

Define o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parâmetros

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

Retornar

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