Creates and appends a newHorizontalRule.

TheHorizontalRule will be contained in a newParagraph.

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.

The image will be contained in a newParagraph.

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.

TheInlineImage will be contained in a newParagraph.

Use this version ofappendImage when appending a copy of an existingInlineImage.

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

Use this version ofappendListItem when appending a copy of an existingListItem.

Parameters

Return

ListItem — The appended list item.

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 newListItem containing the specified text contents.

Consecutive list items are added as part of the same list.

Parameters

Return

ListItem — The new list item.

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.

ThePageBreak will be contained in a newParagraph.

Return

PageBreak — The new page break.

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.

ThePageBreak will be contained in a newParagraph.

Use this version ofappendPageBreak when appending a copy of an existingPageBreak.

Parameters

Return

PageBreak — The appended page break.

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

Use this version ofappendParagraph when appending a copy of an existingParagraph.

Parameters

Return

Paragraph — The appended paragraph.

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 newParagraph containing the specified text contents.

Parameters

Return

Paragraph — The new paragraph.

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

This method will also append an empty paragraph after the table, since Google Docs documentscannot end with a table.

Return

Table — The new table.

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 a newTable containing aTableCell for each specified string value.

This method will also append an empty paragraph after the table, since Google Docs documentscannot end with a table.

Parameters

Return

Table — The appended table.

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

Use this version ofappendTable when appending a copy of an existingTable.This method will also append an empty paragraph after the table, since Google Docs documentscannot end with a table.

Parameters

Return

Table — The appended table.

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

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

Body — 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 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 set of attributes for the providedParagraphHeading.

Parameters

Return

Object — A map of the attributes and their current values.

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 all theInlineImages contained in the section.

Return

InlineImage[]|null — The section 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 all theListItems contained in the section.

Return

ListItem[]|null — The section list items.

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 bottom margin, in points.

Return

Number|null — The bottom margin, 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 left margin, in points.

Return

Number|null — The left margin, 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 right margin.

Return

Number|null — The right margin, 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 top margin.

Return

Number|null — The top margin, 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 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 page height, in points.

Return

Number|null — The page height, 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 page width, in points.

Return

Number|null — The page width, 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 all theParagraphs contained in the section (includingListItems).

Return

Paragraph[]|null — The section paragraphs.

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

Retrieves all theTables contained in the section.

Return

Table[]|null — The section tables.

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 a newHorizontalRule at the specified index.

TheHorizontalRule will be contained in a newParagraph.

Parameters

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 inserts anInlineImage from the specified image blob, at the specifiedindex.

Parameters

Return

InlineImage — The inserted inline 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

Inserts the givenInlineImage at the specified index.

The image will be contained in a newParagraph.

Parameters

Return

InlineImage — The inserted inline 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

Inserts the givenListItem at the specified index.

Parameters

Return

ListItem — The inserted list item.

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 newListItem at the specified index, containing the specifiedtext contents.

Parameters

Return

ListItem — The new list item.

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.

ThePageBreak will be contained in a newParagraph.

Parameters

Return

PageBreak — The new page break.

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.

ThePageBreak will be contained in a newParagraph.

Parameters

Return

PageBreak — The inserted page break.

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 givenParagraph at the specified index.

Parameters

Return

Paragraph — The inserted paragraph.

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 newParagraph at the specified index, containing the specifiedtext contents.

Parameters

Return

Paragraph — The new paragraph.

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 newTable at the specified index.

Parameters

Return

Table — The new table.

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 newTable containing the specified cells, at the specified index.

Parameters

Return

Table — The new table.

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 givenTable at the specified index.

Parameters

Return

Table — The inserted table.

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

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

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

Body — 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 attributes for the providedParagraphHeading.

Parameters

Return

Body — 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 bottom margin, in points.

Parameters

Return

Body — 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 margin, in points.

Parameters

Return

Body — 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 right margin, in points.

Parameters

Return

Body — 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 top margin.

Parameters

Return

Body — 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 page height, in points.

Parameters

Return

Body — 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 page width, in points.

Parameters

Return

Body — 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 as plain text.

Note: existing contents are cleared.

Parameters

Return

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

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

Deprecated. This element cannot contain aFootnote.

Retrieves all theFootnotes contained in the section.

Return

Footnote[]|null — The section footnotes.

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

Deprecated. Instead of applying a link to an entire section, apply the link to an element within the section instead.

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

Deprecated. This element does not have any siblings.

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

Deprecated. This element does not have any siblings.

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

Deprecated. This method is not reliable forHeaderSection.

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

Deprecated. Instead of applying a link to an entire section, apply the link to an element within the section instead.

Sets the link url.

Parameters

Return

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