Creates and inserts a newPositionedImage from the specified image blob.

Parameters

Return

PositionedImage — the new positioned image

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and appends a newHorizontalRule.

Return

HorizontalRule — the new horizontal rule

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and appends a newInlineImage from the specified image blob.

Parameters

Return

InlineImage — the appended image

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Appends the givenInlineImage.

Parameters

Return

InlineImage — the appended image

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and appends a newPageBreak.

Note:PageBreaks may not be contained withinTableCells.If the current element is contained in a table cell, an exception will be thrown.

Return

PageBreak — the new page break element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Appends the givenPageBreak.

Note:PageBreaks may not be contained withinTableCells.If the current element is contained in a table cell, an exception will be thrown.

Parameters

Return

PageBreak — the appended page break element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and appends a newText element with the specified contents.

Parameters

Return

Text — the new text element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Appends the givenText element.

Parameters

Return

Text — the appended text element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Clears the contents of the element.

Return

ListItem — The current element.

Returns a detached, deep copy of the current element.

Any child elements present in the element are also copied. The new element doesn't have aparent.

Return

ListItem — The new copy.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Obtains aText version of the current element, for editing.

UseeditAsText for manipulating the elements contents as rich text. TheeditAsText mode ignores non-text elements (such asInlineImage andHorizontalRule).

Child elements fully contained within a deleted text range are removed from the element.

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

Return

Text — a text version of the current element

Searches the contents of the element for a descendant of the specified type.

Parameters

Return

RangeElement|null — A search result indicating the position of the search element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Searches the contents of the element for a descendant of the specified type, starting from thespecifiedRangeElement.

constbody=DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();// Define the search parameters.letsearchResult=null;// Search until the paragraph is found.while((searchResult=body.findElement(DocumentApp.ElementType.PARAGRAPH,searchResult,))){constpar=searchResult.getElement().asParagraph();if(par.getHeading()===DocumentApp.ParagraphHeading.HEADING1){// Found one, update and stop.par.setText('This is the first header.');break;}}

Parameters

Return

RangeElement|null — A search result indicating the next position of the search element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Searches the contents of the element for the specified text pattern using regular expressions.

A subset of the JavaScript regular expression features are not fully supported, such ascapture groups and mode modifiers.

The provided regular expression pattern is independently matched against each text blockcontained in the current element.

Parameters

Return

RangeElement|null — a search result indicating the position of the search text, or null if there is no match

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Searches the contents of the element for the specified text pattern, starting from a givensearch result.

A subset of the JavaScript regular expression features are not fully supported, such ascapture groups and mode modifiers.

The provided regular expression pattern is independently matched against each text blockcontained in the current element.

Parameters

Return

RangeElement|null — a search result indicating the next position of the search text, or null if there is no match

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves theHorizontalAlignment.

Return

HorizontalAlignment|null — the alignment

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the element's attributes.

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

constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Append a styled paragraph.constpar=body.appendParagraph('A bold, italicized paragraph.');par.setBold(true);par.setItalic(true);// Retrieve the paragraph's attributes.constatts=par.getAttributes();// Log the paragraph attributes.for(constattinatts){Logger.log(`${att}:${atts[att]}`);}

Return

Object — The element's attributes.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the child element at the specified child index.

constbody=DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();// Obtain the first element in the tab.constfirstChild=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.');}

Parameters

Return

Element — The child element at the specified index.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the child index for the specified child element.

Parameters

Return

Integer — The child index.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the list item'sGlyphType.

Return

GlyphType|null — the glyph type

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves theParagraphHeading.

Return

ParagraphHeading|null — the heading

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the end indentation, in points.

Return

Number|null — the end indentation, in points

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the first line indentation, in points.

Return

Number|null — the first line indentation, in points

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the start indentation.

Return

Number|null — the start indentation

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the line spacing, in points.

Return

Number|null — the line spacing, in points

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the link url.

Return

String|null — the link url, or null if the element contains multiple values for this attribute

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the list ID.

Return

String|null — the list ID

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the list item's nesting level.

By default, list items have a nesting level of zero. The nesting level determines the glyphthat is used by the list item.

Return

Integer — the nesting level

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the element's next sibling element.

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

Return

Element|null — The next sibling element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the number of children.

constbody=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.`);

Return

Integer — The number of children.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement|null — The parent element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets aPositionedImage by the image's ID.

Parameters

Return

PositionedImage — the positioned image

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets allPositionedImage objects anchored to the paragraph.

Return

PositionedImage[] — a list of positioned images

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the element's previous sibling element.

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

Return

Element|null — The previous sibling element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the spacing after the element, in points.

Return

Number|null — the spacing after the element, in points

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the spacing before the element, in points.

Return

Number|null — the spacing before the element, in points

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the contents of the element as a text string.

Return

String — the contents of the element as text string

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Gets the text alignment. The available types of alignment areDocumentApp.TextAlignment.NORMAL,DocumentApp.TextAlignment.SUBSCRIPT, andDocumentApp.TextAlignment.SUPERSCRIPT.

Return

TextAlignment|null — the type of text alignment, ornull if the text contains multiple types of text alignments or if the text alignment has never been set

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the element'sElementType.

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

constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Obtain the first element in the active tab's body.constfirstChild=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.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and inserts aHorizontalRule at the specified index.

Parameters

Return

HorizontalRule — the new horizontal rule element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and inserts a newInlineImage from the specified image blob, at the specifiedindex.

Parameters

Return

InlineImage — the inserted inline image element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Inserts the givenInlineImage at the specified index.

Parameters

Return

InlineImage — the inserted inline image element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and inserts a newPageBreak at the specified index.

Note:PageBreaks may not be contained withinTableCells.If the current element is contained in a table cell, an exception will be thrown.

Parameters

Return

PageBreak — the new page break element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Inserts the givenPageBreak at the specified index.

Note:PageBreaks may not be contained withinTableCells.If the current element is contained in a table cell, an exception will be thrown.

Parameters

Return

PageBreak — the inserted page break element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Creates and inserts a new text element at the specified index.

Parameters

Return

Text — the new text element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Inserts the givenText element at the specified index, with the specified textcontents.

Parameters

Return

Text — the inserted text element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Determines whether the element is at the end of theDocument.

Return

Boolean — Whether the element is at the end of the tab.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Retrieves the left-to-right setting.

Return

Boolean|null — the left-to-right setting

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

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

Only elements of the sameElementType can be merged. Any child elements contained inthe current element are moved to the preceding sibling element.

The current element is removed from the document.

constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Example 1: Merge paragraphs// Append two paragraphs to the document's active tab.constpar1=body.appendParagraph('Paragraph 1.');constpar2=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.constcells=[['Row 1, Cell 1','Row 1, Cell 2'],['Row 2, Cell 1','Row 2, Cell 2'],];// Build a table from the array.consttable=body.appendTable(cells);// Get the first row in the table.constrow=table.getRow(0);// Get the two cells in this row.constcell1=row.getCell(0);constcell2=row.getCell(1);// Merge the current cell into its preceding sibling element.constmerged=cell2.merge();

Return

ListItem|null — The merged element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Removes the specified child element.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Removes the element from its parent.

constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Remove all images in the active tab's body.constimgs=body.getImages();for(leti=0;i <imgs.length;i++){imgs[i].removeFromParent();}

Return

ListItem|null — The removed element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Removes aPositionedImage by the image's ID.

Parameters

Return

Boolean — whether or not the specified image was removed

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Replaces all occurrences of a given text pattern with a given replacement string, using regularexpressions.

The search pattern is passed as a string, not a JavaScript regular expression object.Because of this you'll need to escape any backslashes in the pattern.

This methods uses Google'sRE2 regularexpression library, which limits thesupported syntax.

The provided regular expression pattern is independently matched against each text blockcontained in the current element.

constbody=DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();// Clear the text surrounding "Apps Script", with or without text.body.replaceText('^.*Apps ?Script.*$','Apps Script');

Parameters

Return

Element — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets theHorizontalAlignment.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the element's attributes.

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

constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Define a custom paragraph style.conststyle={};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.constpar=body.appendParagraph('A paragraph with custom style.');// Apply the custom style.par.setAttributes(style);

Parameters

Return

ListItem — The current element.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the list item'sGlyphType.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets theParagraphHeading.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the end indentation, in points.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the first line indentation, in points.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the start indentation, in points.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the left-to-right setting.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the line spacing, as a quantity indicating the number of lines to use for spacing.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the link url.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the list ID.

The list ID is set to the same value for the specifiedListItem. The twoListItems will be treated as members of the same list.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the list item's nesting level.

By default, list items have a nesting level of zero. The nesting level determines the glyphthat is used by the list item.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the spacing after the element, in points.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the spacing before the element, in points.

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the contents of the list item as text.

Note: existing contents are cleared.

Parameters

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Sets the text alignment. The available types of alignment areDocumentApp.TextAlignment.NORMAL,DocumentApp.TextAlignment.SUBSCRIPT, andDocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.constdocumentTab=DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();consttext=documentTab.getBody().getParagraphs()[0].editAsText();text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameters

Return

ListItem — the current element

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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