Interface Element

asBody()

Returns the current element as a Body.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Body — the current element

asEquation()

Returns the current element as a Equation.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Equation — the current element

asEquationFunction()

Returns the current element as a EquationFunction.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

EquationFunction — the current element

asEquationFunctionArgumentSeparator()

Returns the current element as a EquationFunctionArgumentSeparator.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

EquationFunctionArgumentSeparator — the current element

asEquationSymbol()

Returns the current element as a EquationSymbol.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

EquationSymbol — the current element

asFooterSection()

Returns the current element as a FooterSection.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

FooterSection — the current element

asFootnote()

Returns the current element as a Footnote.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Footnote — the current element

asFootnoteSection()

Returns the current element as a FootnoteSection.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

FootnoteSection — the current element

asHeaderSection()

Returns the current element as a HeaderSection.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

HeaderSection — the current element

asHorizontalRule()

Returns the current element as a HorizontalRule.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

HorizontalRule — the current element

asInlineDrawing()

Returns the current element as a InlineDrawing.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

InlineDrawing — the current element

asInlineImage()

Returns the current element as a InlineImage.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

InlineImage — the current element

asListItem()

Returns the current element as a ListItem.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

ListItem — the current element

asPageBreak()

Returns the current element as a PageBreak.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

PageBreak — the current element

asParagraph()

Returns the current element as a Paragraph.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Paragraph — the current element

asTable()

Returns the current element as a Table.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Table — the current element

asTableCell()

Returns the current element as a TableCell.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

TableCell — the current element

asTableOfContents()

Returns the current element as a TableOfContents.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

TableOfContents — the current element

asTableRow()

Returns the current element as a TableRow.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

TableRow — the current element

asText()

Returns the current element as a Text.

Use this method to aid auto-complete whenever a given element is known to be of a specific type.

Return

Text — the current element

copy()

Returns a detached, deep copy of the current element.

Any child elements present in the element are also copied. The new element will not have a parent.

Return

Element — the new copy

getAttributes()

Retrieves the element's attributes.

The result is an object containing a property for each valid element attribute where each property name corresponds to an item in the DocumentApp.Attribute enumeration.

 

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

Return

Object — the element's attributes

getNextSibling()

Retrieves the element's next sibling element.

The next sibling has the same parent and follows the current element.

Return

Element — the next sibling element

getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement — the parent element

getPreviousSibling()

Retrieves the element's previous sibling element.

The previous sibling has the same parent and precedes the current element.

Return

Element — the previous sibling element

getType()

Retrieves the element's ElementType.

Use getType() to determine the exact type of a given element.

 

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

Return

ElementType — the element type

isAtDocumentEnd()

Determines whether the element is at the end of the Document.

Return

Boolean — whether the element is at the end of the document

merge()

Merges the element with the preceding sibling of the same type.

Only elements of the same ElementType may be merged. Any child elements contained in the current element are moved to the preceding sibling element.

The current element is removed from the document.

 

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

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

Return

Element — the merged element

removeFromParent()

Removes the element from its parent.

 

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

Return

Element — the removed element

setAttributes(attributes)

Sets the element's attributes.

The specified attributes parameter must be an object where each property name is an item in the DocumentApp.Attribute enumeration and each property value is the new value to be applied.

 

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

Parameters

Return

Element — the current element