Class ContainerElement

Retorna o elemento atual como um Body.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

Body: o elemento atual.

Autorização

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

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

Retorna o elemento atual como um Equation.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um FooterSection.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um FootnoteSection.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um HeaderSection.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um ListItem.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um Paragraph.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

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

Retorna o elemento atual como um Table.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um TableCell.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um TableOfContents.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Retorna o elemento atual como um TableRow.

Use esse método para ajudar o preenchimento automático sempre que um determinado elemento for conhecido como de um tipo específico.

Retornar

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

Limpa o conteúdo do elemento.

Retornar

ContainerElement: o elemento atual.

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

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

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

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

Parâmetros

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

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

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

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

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

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

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

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

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

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

Recupera o índice filho para o elemento filho especificado.

Parâmetros

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Retornar

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

Define o URL do link.

Parâmetros

Retornar

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

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

Retornar

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