Creates and appends a newTableRow.

Return

TableRow — the new table row 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 givenTableRow.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table in the tab and copies the second row.consttable=body.getTables()[0];constrow=table.getChild(1).copy();// Adds the copied row to the bottom of the table.consttableRow=table.appendTableRow(row);

Parameters

Return

TableRow — The appended table row 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

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

Table — 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 border color.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Sets the border color of the first table.table.setBorderColor('#00FF00');// Logs the border color of the first table to the console.console.log(table.getBorderColor());

Return

String|null — The border color, formatted in CSS notation (like'#ffffff').

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 border width, in points.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Sets the border width of the first table.table.setBorderWidth(20);// Logs the border width of the first table.console.log(table.getBorderWidth());

Return

Number|null — The border 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 theTableCell at the specified row and cell indices.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Gets the cell of the table's third row and second column.constcell=table.getCell(2,1);// Logs the cell text to the console.console.log(cell.getText());

Parameters

Return

TableCell|null — The table cell.

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 width of the specified table column, in points.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Sets the width of the second column to 100 points.constcolumnWidth=table.setColumnWidth(1,100);// Gets the width of the second column and logs it to the console.console.log(columnWidth.getColumnWidth(1));

Parameters

Return

Number|null — The column 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 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 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 number ofTableRows.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Logs the number of rows of the first table to the console.console.log(table.getNumRows());

Return

Integer — The number of table rows.

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

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table and logs the text of first row to the console.consttable=body.getTables()[0];console.log(table.getRow(0).getText());

Parameters

Return

TableRow|null — The table row.

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

Parameters

Return

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

Inserts the givenTableRow at the specified index.

Parameters

Return

TableRow — the inserted table row 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

Removes the specified child element.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Finds the first table row and removes it.constelement=table.findElement(DocumentApp.ElementType.TABLE_ROW);table.removeChild(element.getElement());

Parameters

Return

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

Table|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 theTableRow at the specified row index.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table and removes its second row.consttable=body.getTables()[0];table.removeRow(1);

Parameters

Return

TableRow — The removed row.

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

Table — 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 border color.

// Opens the Docs file by its ID. If you created your script from within a// Google Docs file, you can use DocumentApp.getActiveDocument() instead.// TODO(developer): Replace the ID with your own.constdoc=DocumentApp.openById('123abc');// Gets the body contents of the tab by its ID.// TODO(developer): Replace the ID with your own.constbody=doc.getTab('123abc').asDocumentTab().getBody();// Gets the first table.consttable=body.getTables()[0];// Sets the border color of the table to green.table.setBorderColor('#00FF00');

Parameters

Return

Table — 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 border width, in points.

Parameters

Return

Table — 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 width of the specified column, in points.

Parameters

Return

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

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

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