Interface Element

Elemento

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

Como implementar classes

NomeBreve descrição
BodyUm elemento que representa o corpo de um documento.
ContainerElementUm elemento genérico que pode conter outros elementos.
DateElemento que representa uma data formatada
EquationElemento que representa uma expressão matemática.
EquationFunctionUm elemento que representa uma função em uma Equation matemática.
EquationFunctionArgumentSeparatorUm elemento que representa um separador de função em uma Equation matemática.
EquationSymbolElemento que representa um símbolo em uma Equation matemática.
FooterSectionUm elemento que representa uma seção de rodapé.
FootnoteUm elemento que representa uma nota de rodapé.
FootnoteSectionUm elemento que representa uma seção de nota de rodapé.
HeaderSectionUm elemento que representa uma seção de cabeçalho.
HorizontalRuleUm elemento que representa uma regra horizontal.
InlineDrawingElemento que representa um desenho incorporado.
InlineImageUm elemento que representa uma imagem incorporada.
ListItemElemento que representa um item da lista.
PageBreakUm elemento que representa uma quebra de página.
ParagraphUm elemento que representa um parágrafo.
PersonElemento que representa um link para uma pessoa.
RichLinkUm elemento que representa um link para um recurso do Google, como um arquivo do Drive ou um vídeo do YouTube.
TableUm elemento que representa uma tabela.
TableCellUm elemento que representa uma célula de tabela.
TableOfContentsUm elemento que contém um índice.
TableRowUm elemento que representa uma linha da tabela.
TextUm elemento que representa uma região de rich text.
UnsupportedElementUm 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étodoTipo de retornoBreve descrição
asBody()BodyRetorna o elemento atual como um Body.
asDate()DateRetorna o elemento atual como um Date.
asEquation()EquationRetorna o elemento atual como um Equation.
asEquationFunction()EquationFunctionRetorna o elemento atual como um EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorRetorna o elemento atual como um EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolRetorna o elemento atual como um EquationSymbol.
asFooterSection()FooterSectionRetorna o elemento atual como um FooterSection.
asFootnote()FootnoteRetorna o elemento atual como um Footnote.
asFootnoteSection()FootnoteSectionRetorna o elemento atual como um FootnoteSection.
asHeaderSection()HeaderSectionRetorna o elemento atual como um HeaderSection.
asHorizontalRule()HorizontalRuleRetorna o elemento atual como um HorizontalRule.
asInlineDrawing()InlineDrawingRetorna o elemento atual como um InlineDrawing.
asInlineImage()InlineImageRetorna o elemento atual como um InlineImage.
asListItem()ListItemRetorna o elemento atual como um ListItem.
asPageBreak()PageBreakRetorna o elemento atual como um PageBreak.
asParagraph()ParagraphRetorna o elemento atual como um Paragraph.
asPerson()PersonRetorna o elemento atual como um Person.
asRichLink()RichLinkRetorna o elemento atual como RichLink, por exemplo, um link para um arquivo do Planilhas Google.
asTable()TableRetorna o elemento atual como um Table.
asTableCell()TableCellRetorna o elemento atual como um TableCell.
asTableOfContents()TableOfContentsRetorna o elemento atual como um TableOfContents.
asTableRow()TableRowRetorna o elemento atual como um TableRow.
asText()TextRetorna o elemento atual como um Text.
copy()ElementRetorna uma cópia profunda desanexada do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final da Document.
merge()ElementMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()ElementRemove o elemento do pai.
setAttributes(attributes)ElementDefine os atributos do elemento.

Documentação detalhada

asBody()

Retorna o elemento atual como um Body.

Use esse método para auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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ê souber que um elemento é um Date, use esse método para definir o tipo dele como um Date. Isso permite que o preenchimento automático no editor do Apps Script mostre os métodos que você pode usar com um Date.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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ê souber que um elemento é uma 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 pessoa.

Retorno

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

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

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

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 auxiliar no preenchimento automático sempre que um determinado elemento for de um tipo específico.

Retorno

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 profunda desanexada do elemento atual.

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

Retorno

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.

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]);
}

Retorno

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.

Retorno

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.

Retorno

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 antecede o elemento atual.

Retorno

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.

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.');
}

Retorno

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.

Retorno

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

merge()

Mescla o elemento com o 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.

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

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

Retorno

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.

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();
}

Retorno

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 especificados precisa ser um objeto em que cada nome de propriedade é um item na enumeração de DocumentApp.Attribute e cada valor de propriedade é o novo valor a ser aplicado.

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

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

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

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

Parâmetros

NomeTipoDescrição
attributesObjectOs atributos do elemento.

Retorno

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