Class TableOfContents

Limpa o conteúdo do elemento.

Retornar

TableOfContents: o elemento atual

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

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

Retornar

TableOfContents: 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 de Text do elemento atual para edição.

Use a 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

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

Parâmetros

Retornar

RangeElement: um resultado 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 um descendente do tipo especificado, começando pela RangeElement especificada.

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

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

Um subconjunto dos recursos de expressão regular em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde de maneira independente para cada bloco de texto contido no elemento atual.

Parâmetros

Retornar

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

Um subconjunto dos recursos de expressão regular em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido corresponde de maneira independente para 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 de pesquisa ou, se não houver correspondência, será nulo.

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.

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

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

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 do 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 contiver 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 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 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 contiver vários tipos de alinhamento de texto ou se o alinhamento do texto nunca tiver sido definido

Autorização

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

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

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

Determina se o elemento está no fim do Document.

Retornar

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

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.

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

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

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

Esses métodos usam a biblioteca de expressão regular RE2 do Google, que limita a sintaxe compatível.

O padrão de expressão regular fornecido corresponde de maneira independente para 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

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

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

Define o URL do link.

Parâmetros

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

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

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