Google Apps Script

Class HeaderSection

An element representing a header section. A Document typically contains at most one HeaderSection. The HeaderSection may contain ListItem, Paragraph, and Table elements. For more information on document structure, see the guide to extending Google Docs.

Methods

MethodReturn typeBrief description
appendHorizontalRule()HorizontalRuleCreates and appends a new HorizontalRule.
appendImage(image)InlineImageCreates and appends a new InlineImage from the specified image blob.
appendImage(image)InlineImageAppends the given InlineImage.
appendListItem(listItem)ListItemAppends the given ListItem.
appendListItem(text)ListItemCreates and appends a new ListItem containing the specified text contents.
appendParagraph(paragraph)ParagraphAppends the given Paragraph.
appendParagraph(text)ParagraphCreates and appends a new Paragraph containing the specified text contents.
appendTable()TableCreates and appends a new Table.
appendTable(cells)TableAppends a new Table containing a TableCell for each specified string value.
appendTable(table)TableAppends the given Table.
clear()HeaderSectionClears the contents of the element.
copy()HeaderSectionReturns a detached, deep copy of the current element.
editAsText()TextObtains a Text version of the current element, for editing.
findElement(elementType)RangeElementSearches the contents of the element for a descendant of the specified type.
findElement(elementType, from)RangeElementSearches the contents of the element for a descendant of the specified type, starting from the specified RangeElement.
findText(searchPattern)RangeElementSearches the contents of the element for the specified text pattern using regular expressions.
findText(searchPattern, from)RangeElementSearches the contents of the element for the specified text pattern, starting from a given search result.
getAttributes()ObjectRetrieves the element's attributes.
getChild(childIndex)ElementRetrieves the child element at the specified child index.
getChildIndex(child)IntegerRetrieves the child index for the specified child element.
getImages()InlineImage[]Retrieves all the InlineImages contained in the section.
getListItems()ListItem[]Retrieves all the ListItems contained in the section.
getNumChildren()IntegerRetrieves the number of children.
getParagraphs()Paragraph[]Retrieves all the Paragraphs contained in the section.
getParent()ContainerElementRetrieves the element's parent element.
getTables()Table[]Retrieves all the Tables contained in the section.
getText()StringRetrieves the contents of the element as a text string.
getType()ElementTypeRetrieves the element's ElementType.
insertHorizontalRule(childIndex)HorizontalRuleCreates and inserts a new HorizontalRule at the specified index.
insertImage(childIndex, image)InlineImageCreates and inserts an InlineImage from the specified image blob, at the specified index.
insertImage(childIndex, image)InlineImageInserts the given InlineImage at the specified index.
insertListItem(childIndex, listItem)ListItemInserts the given ListItem at the specified index.
insertListItem(childIndex, text)ListItemCreates and inserts a new ListItem at the specified index, containing the specified text contents.
insertParagraph(childIndex, paragraph)ParagraphInserts the given Paragraph at the specified index.
insertParagraph(childIndex, text)ParagraphCreates and inserts a new Paragraph at the specified index, containing the specified text contents.
insertTable(childIndex)TableCreates and inserts a new Table at the specified index.
insertTable(childIndex, cells)TableCreates and inserts a new Table containing the specified cells, at the specified index.
insertTable(childIndex, table)TableInserts the given Table at the specified index.
removeChild(child)HeaderSectionRemoves the specified child element.
removeFromParent()HeaderSectionRemoves the element from its parent.
replaceText(searchPattern, replacement)ElementReplaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
setAttributes(attributes)HeaderSectionSets the element's attributes.
setText(text)HeaderSectionSets the contents as plain text.

Detailed documentation

appendHorizontalRule()

Creates and appends a new HorizontalRule.

The HorizontalRule will be contained in a new Paragraph.

Return

HorizontalRule — the new horizontal rule


appendImage(image)

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

The image will be contained in a new Paragraph.

Parameters

NameTypeDescription
imageBlobSourcethe image data

Return

InlineImage — the appended image


appendImage(image)

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

NameTypeDescription
imageInlineImagethe image data

Return

InlineImage — the appended image


appendListItem(listItem)

Appends the given ListItem.

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

Parameters

NameTypeDescription
listItemListItemthe list item to append

Return

ListItem — the appended list item


appendListItem(text)

Creates and appends a new ListItem containing the specified text contents.

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

Parameters

NameTypeDescription
textStringthe list item's text contents

Return

ListItem — the new list item


appendParagraph(paragraph)

Appends the given Paragraph.

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

Parameters

NameTypeDescription
paragraphParagraphthe paragraph to append

Return

Paragraph — the appended paragraph


appendParagraph(text)

Creates and appends a new Paragraph containing the specified text contents.

Parameters

NameTypeDescription
textStringthe paragraph's text contents

Return

Paragraph — the new paragraph


appendTable()

Creates and appends a new Table.

Return

Table — the new table


appendTable(cells)

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

Parameters

NameTypeDescription
cellsString[][]the text contents of the table cells to add to the new table.

Return

Table — the appended table


appendTable(table)

Appends the given Table.

Use this version of appendTable when appending a copy of an existing Table.

Parameters

NameTypeDescription
tableTablethe table to append

Return

Table — the appended table


clear()

Clears the contents of the element.

Return

HeaderSection — the current element


copy()

Returns a detached, deep copy of the current element.

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

Return

HeaderSection — the new copy


editAsText()

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.

 
var body = DocumentApp.getActiveDocument().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


findElement(elementType)

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

Parameters

NameTypeDescription
elementTypeElementTypethe type of element to search for

Return

RangeElement — a search result indicating the position of the search element


findElement(elementType, from)

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

 
// Get the body section of the active document.
 var body = DocumentApp.getActiveDocument().getBody();

 // Define the search parameters.
 var searchType = DocumentApp.ElementType.PARAGRAPH;
 var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
 var searchResult = null;

 // Search until the paragraph is found.
 while (searchResult = body.findElement(searchType, searchResult)) {
   var par = searchResult.getElement().asParagraph();
   if (par.getHeading() == searchHeading) {
     // Found one, update and stop.
     par.setText('This is the first header.');
     return;
   }
 }
 

Parameters

NameTypeDescription
elementTypeElementTypethe type of element to search for
fromRangeElementthe search result to search from

Return

RangeElement — a search result indicating the next position of the search element


findText(searchPattern)

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

NameTypeDescription
searchPatternStringthe pattern to search for

Return

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


findText(searchPattern, from)

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

NameTypeDescription
searchPatternStringthe pattern to search for
fromRangeElementthe search result to search from

Return

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


getAttributes()

Retrieves the element's attributes.

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

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

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

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

 // Log the paragraph attributes.
 for (var att in atts) {
   Logger.log(att + ":" + atts[att]);
 }
 

Return

Object — the element's attributes


getChild(childIndex)

Retrieves the child element at the specified child index.

 
// Get the body section of the active document.
 var body = DocumentApp.getActiveDocument().getBody();

 // Obtain the first element in the document.
 var 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

NameTypeDescription
childIndexIntegerthe index of the child element to retrieve

Return

Element — the child element at the specified index


getChildIndex(child)

Retrieves the child index for the specified child element.

Parameters

NameTypeDescription
childElementthe child element for which to retrieve the index

Return

Integer — the child index


getImages()

Retrieves all the InlineImages contained in the section.

Return

InlineImage[] — the section images


getListItems()

Retrieves all the ListItems contained in the section.

Return

ListItem[] — the section list items


getNumChildren()

Retrieves the number of children.

 
// Get the body section of the active document.
 var body = DocumentApp.getActiveDocument().getBody();

 // Log the number of elements in the document.
 Logger.log("There are " + body.getNumChildren() +
     " elements in the document body.");
 

Return

Integer — the number of children


getParagraphs()

Retrieves all the Paragraphs contained in the section.

Return

Paragraph[] — the section paragraphs


getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement — the parent element


getTables()

Retrieves all the Tables contained in the section.

Return

Table[] — the section tables


getText()

Retrieves the contents of the element as a text string.

Return

String — the contents of the element as text string


getType()

Retrieves the element's ElementType.

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

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

 // Obtain the first element in the document body.

 var firstChild = body.getChild(0);

 // Use getType() to determine the element's type.
 if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
   Logger.log('The first element is a paragraph.');
 } else {
   Logger.log('The first element is not a paragraph.');
 }
 

Return

ElementType — the element type


insertHorizontalRule(childIndex)

Creates and inserts a new HorizontalRule at the specified index.

The HorizontalRule will be contained in a new Paragraph.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element

Return

HorizontalRule — the new horizontal rule


insertImage(childIndex, image)

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

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element
imageBlobSourcethe image data

Return

InlineImage — the inserted inline image


insertImage(childIndex, image)

Inserts the given InlineImage at the specified index.

The image will be contained in a new Paragraph.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element
imageInlineImagethe image to insert

Return

InlineImage — the inserted inline image


insertListItem(childIndex, listItem)

Inserts the given ListItem at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
listItemListItemthe list item to insert

Return

ListItem — the inserted list item


insertListItem(childIndex, text)

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

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
textStringthe list item's text contents

Return

ListItem — the new list item


insertParagraph(childIndex, paragraph)

Inserts the given Paragraph at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
paragraphParagraphthe paragraph to insert

Return

Paragraph — the inserted paragraph


insertParagraph(childIndex, text)

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

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
textStringthe paragraph's text contents

Return

Paragraph — the new paragraph


insertTable(childIndex)

Creates and inserts a new Table at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert

Return

Table — the new table


insertTable(childIndex, cells)

Creates and inserts a new Table containing the specified cells, at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
cellsString[][]the text contents of the table cells to add to the new table

Return

Table — the new table


insertTable(childIndex, table)

Inserts the given Table at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert
tableTablethe table to insert

Return

Table — the inserted table


removeChild(child)

Removes the specified child element.

Parameters

NameTypeDescription
childElementthe child element to remove

Return

HeaderSection — the current element


removeFromParent()

Removes the element from its parent.

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

 // Remove all images in the document body.
 var imgs = body.getImages();
 for (var i = 0; i < imgs.length; i++) {
   imgs[i].removeFromParent();
 }
 

Return

HeaderSection — the removed element


replaceText(searchPattern, replacement)

Replaces all occurrences of a given text pattern with a given replacement string, 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.

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

 // Clear the text surrounding "Apps Script", with or without text.
 body.replaceText("^.*Apps ?Script.*$", "Apps Script");
 

Parameters

NameTypeDescription
searchPatternStringthe regex pattern to search for
replacementStringthe text to use as replacement

Return

Element — the current element


setAttributes(attributes)

Sets the element's attributes.

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

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

 // Define a custom paragraph style.
 var style = {};
 style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
     DocumentApp.HorizontalAlignment.RIGHT;
 style[DocumentApp.Attribute.FONT_FAMILY] =
     DocumentApp.FontFamily.CALIBRI;
 style[DocumentApp.Attribute.FONT_SIZE] = 18;
 style[DocumentApp.Attribute.BOLD] = true;

 // Append a plain paragraph.
 var par = body.appendParagraph('A paragraph with custom style.');

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

Parameters

NameTypeDescription
attributesObjectthe element's attributes

Return

HeaderSection — the current element


setText(text)

Sets the contents as plain text.

Note: existing contents are cleared.

Parameters

NameTypeDescription
textStringthe new text contents

Return

HeaderSection — the current element

Deprecated methods






Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.