Class HeaderSection

Creates and appends a new HorizontalRule.

The HorizontalRule will be contained in a new Paragraph.

Return

HorizontalRule — The new horizontal rule.

Authorization

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

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

Creates and appends a new InlineImage from the specified image blob.

The image will be contained in a new Paragraph.

Parameters

Return

InlineImage — The appended image.

Authorization

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

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

Appends the given InlineImage.

The InlineImage will be contained in a new Paragraph.

Use this version of appendImage when appending a copy of an existing InlineImage.

Parameters

Return

InlineImage — The appended image.

Authorization

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

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

Appends the given ListItem.

Use this version of appendListItem when appending a copy of an existing ListItem.

Parameters

Return

ListItem — The appended list item.

Authorization

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

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

Creates and appends a new ListItem 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 following scopes:

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

Appends the given Paragraph.

Use this version of appendParagraph when appending a copy of an existing Paragraph.

Parameters

Return

Paragraph — The appended paragraph.

Authorization

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

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

Creates and appends a new Paragraph 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 following scopes:

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

Creates and appends a new Table.

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

Return

Table — The new table.

Authorization

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

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

Appends a new Table containing a TableCell for each specified string value.

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

Parameters

Return

Table — The appended table.

Authorization

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

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

Appends the given Table.

Use this version of appendTable when appending a copy of an existing Table. This method will also append an empty paragraph after the table, since Google Docs documents cannot end with a table.

Parameters

Return

Table — The appended table.

Authorization

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

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

Clears the contents of the element.

Return

HeaderSection — 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 a parent.

Return

HeaderSection — The new copy.

Authorization

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

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

Obtains a Text version of the current element, for editing.

Use editAsText for manipulating the elements contents as rich text. The editAsText mode ignores non-text elements (such as InlineImage and HorizontalRule).

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

const body =
    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 — A search result indicating the position of the search element.

Authorization

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

• 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 the specified RangeElement.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = 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 — 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 following scopes:

• 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 as capture groups and mode modifiers.

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

Parameters

Return

RangeElement — 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 following scopes:

• 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 given search result.

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

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

Parameters

Return

RangeElement — 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 following scopes:

• 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 each property name corresponds to an item in the DocumentApp.Attribute enumeration.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  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 following scopes:

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

Retrieves the child element at the specified child index.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = 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 following scopes:

• 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 following scopes:

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

Retrieves all the InlineImages contained in the section.

Return

InlineImage[] — The section images.

Authorization

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

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

Retrieves all the ListItems contained in the section.

Return

ListItem[] — The section list items.

Authorization

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

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

Retrieves the number of children.

const body =
    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 following scopes:

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

Retrieves all the Paragraphs contained in the section (including ListItems).

Return

Paragraph[] — The section paragraphs.

Authorization

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

• 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 — The parent element.

Authorization

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

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

Retrieves all the Tables contained in the section.

Return

Table[] — The section tables.

Authorization

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

• 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 following scopes:

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

Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.

Return

TextAlignment — the type of text alignment, or null 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 following scopes:

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

Retrieves the element's ElementType.

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

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

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

Authorization

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

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

Creates and inserts a new HorizontalRule at the specified index.

The HorizontalRule will be contained in a new Paragraph.

Parameters

Return

HorizontalRule — The new horizontal rule.

Authorization

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

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

Creates and inserts an InlineImage from the specified image blob, at the specified index.

Parameters

Return

InlineImage — The inserted inline image.

Authorization

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

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

Inserts the given InlineImage at the specified index.

The image will be contained in a new Paragraph.

Parameters

Return

InlineImage — The inserted inline image.

Authorization

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

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

Inserts the given ListItem 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 following scopes:

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

Creates and inserts a new ListItem at the specified index, containing the specified text contents.

Parameters

Return

ListItem — The new list item.

Authorization

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

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

Inserts the given Paragraph at the specified index.

Parameters

Return

Paragraph — The inserted paragraph.

Authorization

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

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

Creates and inserts a new Paragraph at the specified index, 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 following scopes:

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

Creates and inserts a new Table at the specified index.

Parameters

Return

Table — The new table.

Authorization

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

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

Creates and inserts a new Table 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 following scopes:

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

Inserts the given Table at the specified index.

Parameters

Return

Table — The inserted table.

Authorization

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

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

Removes the specified child element.

Parameters

Return

HeaderSection — The current element.

Authorization

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

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

Removes the element from its parent.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return

HeaderSection — The removed element.

Authorization

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

• 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 regular expressions.

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's RE2 regular expression library, which limits the supported syntax.

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

const body =
    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 following scopes:

• 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 in the DocumentApp.Attribute enumeration and each property value is the new value to be applied.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

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

Parameters

Return

HeaderSection — The current element.

Authorization

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

• 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

HeaderSection — The current element.

Authorization

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

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

Sets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.

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

Parameters

Return

HeaderSection — the current element

Authorization

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

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