Esta página foi traduzida pela API Cloud Translation.

Interface Element

Um elemento genérico. O conteúdo de Document é representado como elementos. Por exemplo, ListItem, Paragraph e Table são elementos e herdam todos os métodos definidos por Element, como getType().

Implementar classes

Nome	Breve descrição
`Body`	O conteúdo de uma guia em um documento do Documentos Google.
`ContainerElement`	Um elemento genérico que pode conter outros elementos.
`Date`	Um elemento que representa uma data formatada
`Equation`	Um elemento que representa uma expressão matemática.
`EquationFunction`	Um elemento que representa uma função em uma `Equation` matemática.
`EquationFunctionArgumentSeparator`	Um elemento que representa um separador de função em uma `Equation` matemática.
`EquationSymbol`	Um elemento que representa um símbolo em uma `Equation` matemática.
`FooterSection`	Um elemento que representa uma seção de rodapé.
`Footnote`	Um elemento que representa uma nota de rodapé.
`FootnoteSection`	Um elemento que representa uma seção de nota de rodapé.
`HeaderSection`	Um elemento que representa uma seção de cabeçalho.
`HorizontalRule`	Um elemento que representa uma régua horizontal.
`InlineDrawing`	Um elemento que representa um desenho incorporado.
`InlineImage`	Um elemento que representa uma imagem incorporada.
`ListItem`	Um elemento que representa um item de lista.
`PageBreak`	Um elemento que representa um salto de página.
`Paragraph`	Um elemento que representa um parágrafo.
`Person`	Elemento que representa um link para uma pessoa.
`RichLink`	Um elemento que representa um link para um recurso do Google, como um arquivo do Drive ou um vídeo do YouTube.
`Table`	Um elemento que representa uma tabela.
`TableCell`	Um elemento que representa uma célula da tabela.
`TableOfContents`	Um elemento que contém um sumário.
`TableRow`	Um elemento que representa uma linha de tabela.
`Text`	Um elemento que representa uma região de rich text.
`UnsupportedElement`	Um elemento que representa uma região desconhecida ou que não pode ser afetada por um script, como um número de página.

Métodos

Método	Tipo de retorno	Breve descrição
`asBody()`	`Body`	Retorna o elemento atual como um `Body`.
`asDate()`	`Date`	Retorna o elemento atual como um `Date`.
`asEquation()`	`Equation`	Retorna o elemento atual como um `Equation`.
`asEquationFunction()`	`EquationFunction`	Retorna o elemento atual como um `EquationFunction`.
`asEquationFunctionArgumentSeparator()`	`EquationFunctionArgumentSeparator`	Retorna o elemento atual como um `EquationFunctionArgumentSeparator`.
`asEquationSymbol()`	`EquationSymbol`	Retorna o elemento atual como um `EquationSymbol`.
`asFooterSection()`	`FooterSection`	Retorna o elemento atual como um `FooterSection`.
`asFootnote()`	`Footnote`	Retorna o elemento atual como um `Footnote`.
`asFootnoteSection()`	`FootnoteSection`	Retorna o elemento atual como um `FootnoteSection`.
`asHeaderSection()`	`HeaderSection`	Retorna o elemento atual como um `HeaderSection`.
`asHorizontalRule()`	`HorizontalRule`	Retorna o elemento atual como um `HorizontalRule`.
`asInlineDrawing()`	`InlineDrawing`	Retorna o elemento atual como um `InlineDrawing`.
`asInlineImage()`	`InlineImage`	Retorna o elemento atual como um `InlineImage`.
`asListItem()`	`ListItem`	Retorna o elemento atual como um `ListItem`.
`asPageBreak()`	`PageBreak`	Retorna o elemento atual como um `PageBreak`.
`asParagraph()`	`Paragraph`	Retorna o elemento atual como um `Paragraph`.
`asPerson()`	`Person`	Retorna o elemento atual como um `Person`.
`asRichLink()`	`RichLink`	Retorna o elemento atual como um `RichLink`, por exemplo, um link para um arquivo das Planilhas Google.
`asTable()`	`Table`	Retorna o elemento atual como um `Table`.
`asTableCell()`	`TableCell`	Retorna o elemento atual como um `TableCell`.
`asTableOfContents()`	`TableOfContents`	Retorna o elemento atual como um `TableOfContents`.
`asTableRow()`	`TableRow`	Retorna o elemento atual como um `TableRow`.
`asText()`	`Text`	Retorna o elemento atual como um `Text`.
`copy()`	`Element`	Retorna uma cópia detalhada e separada do elemento atual.
`getAttributes()`	`Object`	Recupera os atributos do elemento.
`getNextSibling()`	`Element`	Recupera o próximo elemento irmão do elemento.
`getParent()`	`ContainerElement`	Recupera o elemento pai do elemento.
`getPreviousSibling()`	`Element`	Recupera o elemento irmão anterior do elemento.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final da `Document`.
`merge()`	`Element`	Une o elemento ao elemento irmão anterior do mesmo tipo.
`removeFromParent()`	`Element`	Remove o elemento do pai.
`setAttributes(attributes)`	`Element`	Define os atributos do elemento.

Documentação detalhada

`asBody()`

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

`asDate()`

Retorna o elemento atual como um Date.

Quando você sabe que um elemento é um Date, use esse método para definir o tipo como Date. Isso permite que o preenchimento automático no editor do Apps Script mostre os métodos que você pode usar com um Date.

Retornar

Date: o elemento atual com o tipo definido como Date.

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

`asEquation()`

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

`asEquationFunction()`

Retorna o elemento atual como um EquationFunction.

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

Retornar

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

`asEquationFunctionArgumentSeparator()`

Retorna o elemento atual como um EquationFunctionArgumentSeparator.

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

Retornar

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

`asEquationSymbol()`

Retorna o elemento atual como um EquationSymbol.

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

Retornar

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

`asFooterSection()`

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

`asFootnote()`

Retorna o elemento atual como um Footnote.

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

Retornar

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

`asFootnoteSection()`

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

`asHeaderSection()`

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

`asHorizontalRule()`

Retorna o elemento atual como um HorizontalRule.

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

Retornar

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

`asInlineDrawing()`

Retorna o elemento atual como um InlineDrawing.

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

Retornar

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

`asInlineImage()`

Retorna o elemento atual como um InlineImage.

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

Retornar

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

`asListItem()`

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

`asPageBreak()`

Retorna o elemento atual como um PageBreak.

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

Retornar

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

`asParagraph()`

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

`asPerson()`

Retorna o elemento atual como um Person.

Quando você sabe que um elemento é um Person, use esse método para definir o tipo como uma pessoa. Isso permite que o preenchimento automático no editor do Apps Script mostre os métodos que você pode usar com um elemento de pessoa.

Retornar

Person: o elemento atual com o tipo definido como Person.

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

`asRichLink()`

Retorna o elemento atual como um RichLink, por exemplo, um link para um arquivo das Planilhas Google.

Quando você sabe que um elemento é um RichLink, use esse método para definir o tipo como RichLink. Isso permite que o preenchimento automático no editor do Apps Script mostre os métodos que você pode usar com um RichLink.

Retornar

RichLink: o elemento atual com o tipo definido como RichLink.

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

`asTable()`

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

`asTableCell()`

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

`asTableOfContents()`

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

`asTableRow()`

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

`asText()`

Retorna o elemento atual como um Text.

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

Retornar

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

`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

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

`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

`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

`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

`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

`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

`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

`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

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

`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

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

`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

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